[
https://issues.apache.org/jira/browse/YETUS-199?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15389886#comment-15389886
]
Ajay Yadava commented on YETUS-199:
-----------------------------------
[~aw] Does this mean to provide an option say, 'include' and allow users to
provide ability to specify what all they want to be considered e.g.
--include [default option being public, it will generate docs only for public
API]
--include private [generate docs only for private]
--include private, replaceable [include functions which are either private or
replaceable]
Did I interpret the discussion correctly?
**P.S.** This is not a detailed proposal, just want to verify my understanding.
Once verified, I will put up a detailed proposal.
> 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)
