[
https://issues.apache.org/jira/browse/YETUS-199?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15437118#comment-15437118
]
Allen Wittenauer commented on YETUS-199:
----------------------------------------
yeah, you kind of have the general idea I was thinking. I sort of had an idea
of using some sort of formula-type system. e.g.,
{code}
--include (audience=public)&&(replaceable=no)
{code}
all stabilities that are public and not replaceable
or
{code}
--include (audience=*)&&(stability=stable)&&(replaceable=yes)
{code}
explicitly all audiences that are stable & replaceable.
or
{code}
--include (audience=private|public)&&(stability=stable)&&(replaceable=yes)
{code}
Only audiences that are private or public that are stable and replaceable.
This way one could get _exactly_ what they want and if someone is using a
custom entry (does that even work? haha), we'd support it.
But clearly this is more complicated.
> add option to shelldocs to only generate docs for functions expressly labeled
> "public"
> --------------------------------------------------------------------------------------
>
> Key: YETUS-199
> URL: https://issues.apache.org/jira/browse/YETUS-199
> Project: Yetus
> Issue Type: New Feature
> Components: ShellDocs
> Affects Versions: 0.1.0
> Reporter: Sean Busbey
> Assignee: Ajay Yadava
>
> we use shelldocs to publish docs for precommit. I want to call out the docs
> for our supported API, which is just the things labeled public.
> add an option to limit output to public functions, so I can easily generate
> the docs for our api.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
