On Feb 6, 2013, at 20:51, <damon_car...@ltxc.com> wrote:
> I am not sure I understand what you mean. Does \sa (see also) do what you
> want?
I did not use \sa, but my understanding is that it adds a new section, with
other explicitly given links.
The issue I have is with default cross reverences, more specifically with the
presentation, since the content is fine.
For example, in my configuration, one typical entry would look like:
------------
Display a decimal integer to the test output device.
Parameters
[in] n an integer number.
Returns
The actual number of bytes written to the output device.
Convert the integer to ASCII and send it to the test output device.
Definition at line 340 of file TestSuite.cpp.
References putString().
Referenced by outputLine().
-------------
In other words, the output shows the \brief, the \params, the \returns, the
\details (ok, a not very detailed section in this case) and three lines related
to cross references;
The way I would like it displayes is:
-------------
Display a decimal integer to the test output device.
Parameters
[in] n an integer number.
Returns
The actual number of bytes written to the output device.
Detailed description
Convert the integer to ASCII and send it to the test output device.
Cross references
Definition at line 340 of file TestSuite.cpp.
References putString().
Referenced by outputLine().
-------------
In other words, I would add explicit sections 'Detailed description' and 'Cross
references', using exactly the same styles as for 'Parameters' and 'Returns'.
In my oppinion, increasing the document structure also makes the output more
readable.
Not having these sections automatically generated by Doxygen, all I could do
was to compromise and use something like
> /// \par Detailed description
> ///
> /// \details
> /// Convert the integer to ASCII and send it to the test output device.
> /// \par Cross references
i.e. to manually add a dummy \par before \details and another one at the end of
the \details section.
However, none of the \par lines should be there, since they have to do with
presentation, not with content.
The live page can be seen at
http://micro-os-plus.livius.net/doc/classos_1_1infra_1_1TestSuite.html#a38e13256528975d1aae7edf61e5f4069
Would it be possible to automatically generate the 'Detailed description' and
'Cross references' sections?
Regards,
Liviu
------------------------------------------------------------------------------
Free Next-Gen Firewall Hardware Offer
Buy your Sophos next-gen firewall before the end March 2013
and get the hardware for free! Learn more.
http://p.sf.net/sfu/sophos-d2d-feb
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
