You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by "Bruce Mitchener (JIRA)" <ji...@apache.org> on 2010/03/16 09:16:27 UTC

[jira] Created: (AVRO-476) Documentation: Replace asciidoc with Doxygen?

Documentation: Replace asciidoc with Doxygen?
---------------------------------------------

                 Key: AVRO-476
                 URL: https://issues.apache.org/jira/browse/AVRO-476
             Project: Avro
          Issue Type: Improvement
          Components: c
            Reporter: Bruce Mitchener


Doxygen is a lot more common, more likely to be installed and won't bring in a ton of extra dependencies to get it working...

Thoughts?


-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (AVRO-476) Documentation: Replace asciidoc with Doxygen?

Posted by "Matt Massie (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/AVRO-476?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12846064#action_12846064 ] 

Matt Massie commented on AVRO-476:
----------------------------------

I'm not sure this is an either/or question.  I agree that asciidoc has a number of dependencies but (1) a simple yum/apt-get install easily works and (2) asciidoc is only required on the build box.  The docs are generated as part of the release process.

I'd like to keep asciidoc for the tutorials and examples we write.  It might make sense to complement that with Doxygen generated docs as well.

> Documentation: Replace asciidoc with Doxygen?
> ---------------------------------------------
>
>                 Key: AVRO-476
>                 URL: https://issues.apache.org/jira/browse/AVRO-476
>             Project: Avro
>          Issue Type: Improvement
>          Components: c
>            Reporter: Bruce Mitchener
>
> Doxygen is a lot more common, more likely to be installed and won't bring in a ton of extra dependencies to get it working...
> Thoughts?

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.