reef-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Mariia Mykhailova (JIRA)" <j...@apache.org>
Subject [jira] [Comment Edited] (REEF-113) Integrate .NET API documentation with our website
Date Fri, 15 Jan 2016 23:16:39 GMT

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

Mariia Mykhailova edited comment on REEF-113 at 1/15/16 11:15 PM:
------------------------------------------------------------------

I've tried configuring [Doxygen|http://www.stack.nl/~dimitri/doxygen/] for our .NET code right
now, and it seems to work smoothly, generating a site similar in functionality to our Java
apidoc. It also does nice things like warning about broken documentation comments, etc. Let
me know if there are any concerns about using it.

I have several questions about the appearance of our site, after that I'll send PR with configuration
and fixes for broken documentation.

1. Do we want to keep links to all previous versions on the sidebar of http://reef.apache.org
? Currently there are only 4 versions there, but once we add .NET APIs and release 0.14, it
will be 10 links, and then if we want to increase release frequency, it will grow really fast.
Maybe we can keep there links only to the latest version API (Java and .NET), and for the
rest put links in their download information?

2. Does it matter that our .NET and Java API sites will look very different? Technically Doxygen
has Java support, but I'd rather keep Java site as is.


was (Author: mariiamykhailova):
I've tried configuring [Doxygen|http://www.stack.nl/~dimitri/doxygen/] for our .NET code right
now, and it seems to work smoothly, generating a site similar in functionality to our Java
apidoc. It also does nice things like warning about broken documentation comments, etc. Let
me know if there are any concerns about using it.

I have several questions about the appearance of our site, after that I'll send PR with configuration,
fixes for broken documentation and update of our release script.

1. Do we want to keep links to all previous versions on the sidebar of http://reef.apache.org
? Currently there are only 4 versions there, but once we add .NET APIs and release 0.14, it
will be 10 links, and then if we want to increase release frequency, it will grow really fast.
Maybe we can keep there links only to the latest version API (Java and .NET), and for the
rest put links in their download information?

2. Does it matter that our .NET and Java API sites will look very different? Technically Doxygen
has Java support, but I'd rather keep Java site as is.

> Integrate .NET API documentation with our website
> -------------------------------------------------
>
>                 Key: REEF-113
>                 URL: https://issues.apache.org/jira/browse/REEF-113
>             Project: REEF
>          Issue Type: Improvement
>          Components: REEF.NET, Website
>            Reporter: Markus Weimer
>            Assignee: Mariia Mykhailova
>
> The REEF website today lists the API documentation for our Java code. We should integrate
the API documentation for the .NET code as well.



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

Mime
View raw message