Draft Doxygen configuration file

[Hywan]

This is a draft of the Doxygen configuration file to generate the API documentation.

[Hywan]

Should we run one API documentation per library? So far, doxygen will run on the Central repository. I think it is better because we will be able to navigate through the entire code base.

[Hywan]

Here is the demo: http://api.hoa-project.net/a00696.html.
There is an issue with Doxygen though. When we write @return \Hoa\Foo\Bar, it considers this as a sequence of commands (a command is introduced by \), so the documentation is not complete and we have a bunch of warning.

I like Doxygen because of all the graphes (callee, caller, inheritance etc.). Since recent versions, we can have interactive SVG graphes, which is also very cool (see the demo link). I consider this is the best API generator I know so far, but this bug is kind of blocking :-/.

Thoughts @hoaproject/hoackers?

[osaris]

According to http://technosophos.com/2012/02/01/documenting-php-doxygen-pros-and-cons.html (see "The Dastardly Backslash") you can use Hoa::Foo::Bar or maybe \\Hoa\\Foo\\Bar (seen here http://stackoverflow.com/questions/9385984/how-to-disable-slash-command-syntax-in-doxygen).

Or maybe we can force doxygen to accept commands only with @ and not with \ ?

[harikt]

I prefer something like apigen. Wonder what is the benefit with doxygen.

[thehawk970]

you have too camael24/sohapi 👍 lol

[harikt]

@camael24 :-) . One of the thing I like in apigen is I can go check the source code there itself.

[Hywan]

@harikt Graphes. Doxygen has graphes. This is very powerful for me to get caller and callee graphes, along with UML graphes. Thoughts?

@osaris Yup, we can use :: or \\ but it will break IDE I guess :-/. I am trying to force Doxygen to use @ and not \ to start a command but it seems to not be possible yet. I am looking for using a pre-processor, don't know if it is possible.

[harikt]

@Hywan don't know I like Doxygen though 👍 . Say personal preference ;) .

See some examples how it renders http://apigen.juzna.cz/ . But I am ok for I could create my own ;) .

[Hywan]

@harikt Tried to generate the doc of https://github.com/hoaproject/Central (subdir Hoa/) on juzna.cz but it seems to do not work :-/.

[Hywan]

@harikt Haha, Github URL was incorrect… Now I am just waiting: http://apigen.juzna.cz/homepage/progress?repoId=277.

[harikt]

It has some bug so will not generate now ;-)

Hari K T

You can ring me : +91 9388 75 8821

http://harikt.com , https://github.com/harikt ,
http://www.linkedin.com/in/harikt , http://www.xing.com/profile/Hari_KT

Skype : kthari85
Twitter : harikt

On Tue, Jul 21, 2015 at 1:08 PM, Ivan Enderlin [email protected]
wrote:

@harikt https://github.com/harikt Haha, Github URL was incorrect… Now I
am just waiting: http://apigen.juzna.cz/homepage/progress?repoId=277.

—
Reply to this email directly or view it on GitHub
#22 (comment).

[Hywan]

Are graphes important? For me yes, what about you @hoaproject/hoackers?

[Hywan]

It works: http://apigen.juzna.cz/doc/hoaproject/Central/.
Should we fallback to this service?