fix private member visibility + :private-members: flag, fix #8

Author: boolangery

README.rst

@@ -111,3 +111,14 @@ You can display method source code appending the flag ``show-source``:
 
     .. lua:autoclass:: pl.List
         :show-source:
+
+
+Showing private members
+-------------------------------------------------------------------------------
+
+By default, private members are hidden. You can display them by using the flag ``private-members``:
+
+.. code-block:: rst
+
+    .. lua:autoclass:: pl.List
+        :private-members:

setup.py

@@ -32,7 +32,7 @@
     install_requires=[
         'six',
         'Jinja2>3.0',
-        'luadoc>=1.3.0',
+        'luadoc>=1.3.1',
         'sphinxcontrib-luadomain>=1.1.1'
     ],
     classifiers=[

sphinx_lua/templates/class.rst

@@ -26,17 +26,19 @@
 
 {# display class field #}
 {% for field in model.fields -%}
+{%- if field.visibility == "public" or 'private-members' in options %}
 {%- with type=field.type -%}
 .. lua:attribute:: {{ field.name }}: {% include "type.rst" %}
 
     {{ field.desc }}
 
 {% endwith -%}
+{%- endif %}
 {%- endfor %}
 
 {# display public methods first #}
 {%- for method in model.methods -%}
-{%- if method.visibility == "public" %}
+{%- if method.visibility == "public" or 'private-members' in options %}
 {% include "method.rst" %}
 {%- endif %}
 {%- endfor %}

sphinx_lua/test/index.rst

@@ -1 +1,3 @@
-.. lua:autoclass:: MyOrg.Car
+.. lua:autoclass:: Class
+    :show-source:
+    :private-members:

sphinx_lua/test/source/lua/pl/List.lua

@@ -1,15 +1,24 @@
---- Define a car.
---- @class MyOrg.Car
-local cls = class()
+---@class Class
+---@field public some_public_field string This field is public
+---@field private _some_private_field string This field is private
+local cls = {}
+cls.__index = cls
 
---- @param foo number
-function cls:test(foo)
+---Create a new Class
+---@return Class
+function cls.new()
+    return setmetatable({
+        some_public_field = "public",
+        _some_private_field = "private",
+    }, cls)
 end
 
---- @param bar number
-function cls:_privateMember(bar)
+---Append the public field with `public`
+function cls:more_public()
+    self.some_public_field = self.some_public_field .. "public"
 end
 
---- @param bar number
-function cls:nn(bar)
+---Append the private field with `private`
+function cls:_more_private()
+    self._some_private_field = self._some_private_field .. "private"
 end