search

gazebosim / gz-transport

Transport library for component communication based on publication/subscription and service calls.
https://gazebosim.org
Apache License 2.0
29 stars 43 forks source link

Doxygen doc building fails #29

Closed osrf-migration closed 9 years ago

osrf-migration commented 9 years ago

Original report (archived issue) by Javier V Gómez (Bitbucket: jvgomez).

Hello everyone,

I found a couple of problems when building doc with make doc. Extract of the terminal output:

[100%] Generating API documentation with Doxygen
**Warning: Tag `SYMBOL_CACHE_SIZE' at line 341 of file /home/jabuntu14/Desktop/ign-transport/build/ignition.dox has become obsolete.**
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
**Warning: doxygen no longer ships with the FreeSans font.**
You may want to clear or change DOT_FONTNAME.
Otherwise you run the risk that the wrong font is being used for dot generated graphs.
**Warning: tag INPUT: input source `/home/jabuntu14/Desktop/ign-transport/ignition/transport' does not exist**
Searching for include files...
Searching for files in directory /home/jabuntu14/Desktop/ign-transport/build
....

The last error causes index.html to be mostly useless. The fixes are easy. I was about to create a pull request. However, since I am new in this library, I want to be sure that this is a bug (probably I'm just missing something, actually I think it was designed to have all ignition packages together). The fixes I did to ignition.in are:

INPUT                  = @CMAKE_SOURCE_DIR@/doc/mainpage.html \
                         @CMAKE_SOURCE_DIR@/include/ignition/@IGN_PROJECT_NAME@
DOT_FONTNAME           = Helvetica
# SYMBOL_CACHE_SIZE      = 0

Additionally, I propose to set GENERATE_LATEX = NO.

osrf-migration commented 9 years ago

Original comment by Carlos Agüero (Bitbucket: caguero, GitHub: caguero).

hi @jvgomez, thanks for reporting this issue!

I have updated the doxygen and created pull request #56.

Let me know if works for you and feel free to create pull requests in the future. You're more than welcome.

osrf-migration commented 9 years ago

Original comment by Carlos Agüero (Bitbucket: caguero, GitHub: caguero).

Merged in update_doc (pull request #56)

Fix issue #29

→ \<\<cset 92d103098f128841a8594e7884bd1326b4ec155f>>

osrf-migration commented 9 years ago

Original comment by Carlos Agüero (Bitbucket: caguero, GitHub: caguero).

Fixed in pull request #56.