Various improvements in the doc

[Peter Kovacs]

The attached patches contain various doc fixes and improvements.

[Peter Kovacs]

Attached changesets:

• [7bf489cf624e] Minor fixes and improvements in the doc
• [d9d1cb759951] Add images to the doc of two groups
• [4f9a45a6d6f0] Add references to papers related to LEMON
• [eb2f9d453070] Adjust the formatting of bib2dox.py to Doxygen 1.8.x

[Alpar Juttner]

I pushed all the patches above. However, I'm not satisfied with how the references page is rendered:

The citation code of the references are huge. IMHO, they should be of the same size as the text itself.

Btw, shouldn't we consider #456?

[Peter Kovacs]

Replying to alpar:

I pushed all the patches above. However, I'm not satisfied with how the references page is rendered:

The citation code of the references are huge. IMHO, they should be of the same size as the text itself.

I agree. This was much better with Doxygen 1.7.x, but 1.8.x uses a much larger font size for \section. I tried to use \subsection instead of \section, but that did not work.

Btw, shouldn't we consider #456?

Yes, we should consider #456.

[Alpar Juttner]

I keep this ticket open, because I noticed that there are tons of warnings in doxygen.log. Many of them are probably valid issues.

[Alpar Juttner]

Replying to alpar:

I keep this ticket open, because I noticed that there are tons of warnings in doxygen.log. Many of them are probably valid issues.

I pushed two changeset to the main branch:

• [97d978243703] fixes the majority of the unresolved doc references. What remains is the references to those tools are not yet ported from 0.x. These should be removed in the release branch
• [218171dc022d] makes the location of the gcc reference manual configurable. It also changes the default one to 4.7.3 from the ever changing latest development version.

I think these resolve all the remaining issues.

[Peter Kovacs]

I reopened this ticket as I got a compiler warning that is due to [97d978243703] (using GCC 4.5.x on lime.cs.elte.hu).

The warning is:

lemon/lp_base.h:1010:5: warning: multi-line comment

for this part of the file:

1010    ///\e \ 
1011    class UnsupportedFormatError : public Exception

[Peter Kovacs]

Moreover, it also causes compiler errors like:

lemon/lp_base.h:1012:5: error: expected unqualified-id before ‘{’ token
lemon/lp_base.cc:30:1: error: expected ‘}’ at end of input

[Alpar Juttner]

Replying to kpeter:

1010    ///\e \ 
1011    class UnsupportedFormatError : public Exception

Of course that \ at the end of line 1010 causes the problem. However, if I omit it, then doxygen sends a warning saying

/home/alpar/projects/LEMON/hg/459/lemon/lp_base.h:1009: warning: expected whitespace after e command

This is very strange, for we use ///\e to force documenting a class without adding a description at many places in the source with no problem.

[Alpar Juttner]

The issue above is fixed in [38c432e01489]. Still can't understand why ///\e doesn't work.