You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@mesos.apache.org by "Niklas Quarfot Nielsen (JIRA)" <ji...@apache.org> on 2015/05/27 20:42:17 UTC

[jira] [Commented] (MESOS-2500) Doxygen setup for libprocess

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

Niklas Quarfot Nielsen commented on MESOS-2500:
-----------------------------------------------

So, we have a doxyfile which gets run when we update the website.

The biggest change is to change out comment style, so let doxygen pick it up. 

> Doxygen setup for libprocess
> ----------------------------
>
>                 Key: MESOS-2500
>                 URL: https://issues.apache.org/jira/browse/MESOS-2500
>             Project: Mesos
>          Issue Type: Documentation
>          Components: libprocess
>            Reporter: Bernd Mathiske
>            Assignee: Joerg Schad
>   Original Estimate: 48h
>  Remaining Estimate: 48h
>
> Goals: 
> - Initial doxygen setup. 
> - Enable interested developers to generate already available doxygen content locally in their workspace and view it.
> - Form the basis for future contributions of more doxygen content.
> 1. Devise a way to use Doxygen with Mesos source code. (For example, solve this by adding optional brew/apt-get installation to the "Getting Started" doc.)
> 2. Create a make target for libprocess documentation that can be manually triggered.
> 3. Create initial library top level documentation.
> 4. Enhance one header file with Doxygen. Make sure the generated output has all necessary links to navigate from the lib to the file and back, etc.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)