yetus-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ajay Yadava (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (YETUS-199) add option to shelldocs to only generate docs for functions expressly labeled "public"
Date Tue, 02 Aug 2016 13:36:20 GMT

    [ https://issues.apache.org/jira/browse/YETUS-199?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15403964#comment-15403964
] 

Ajay Yadava commented on YETUS-199:
-----------------------------------

Hey [~aw],

Can you please provide some inputs here?

> 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)

Mime
View raw message