[mini.doc] Support hiding fields marked as private/protected

[kristijanhusak]

Contributing guidelines

• I have read CONTRIBUTING.md
• I have read CODE_OF_CONDUCT.md

Module(s)

mini.doc

Description

Hey,

I'm planning to replace lemmy-help with your mini.doc for API documentation on orgmode.

It works great so far, I just noticed one thing that is missing. Fields marked as private/protected are still generated.

Field can be marked private/protected like this:

---@field private _my_private_field integer
---@field protected _my_protected_field integer

There are also some examples on https://github.com/LuaLS/lua-language-server/wiki/Annotations#field and https://emmylua.github.io/annotations/field.html

This is how mini.doc generates one section on my docs:

                                                                       *OrgFile*
                                   `OrgFile`
Class ~
{OrgFile}
Fields ~
{category} `(string)` current file category name. By default it's only filename without extension unless defined differently via #+CATEGORY directive
{filename} `(string)` absolute path of the current file
{headlines} OrgHeadline[]
{is_archive_file} `(boolean)`
{private} _file File

And this is what lemmy-help does:

OrgFile                                                                *OrgFile*

    Fields: ~
        {category}         (string)         current file category name. By default it's only filename without extension unless defined differently via #+CATEGORY directive
        {filename}         (string)         absolute path of the current file
        {headlines}        (OrgHeadline[])
        {is_archive_file}  (boolean)

Any chance to get this added? Thanks!

[echasnovski]

Thanks for the suggestion!

Looks reasonable. It is also somewhat related to #666.

No guarantees on the timeframe, though.

[echasnovski]

As there have already been several suggestions which are more or less "make this LuaCATS annotation work", I think it is more reasonable to use #666 as a tracking issue. This will keep all suggestions easily skimmable. I've added this one here, so will close this issue.

---

Sorry, there are still no guarantees about when this is going to happen.