I recently enabled the ALWAYS_DETAILED_SEC and I like the result, which made me
think on how things can be further improved.
I would be very happy to see the \detailed section also explicitly marked on
all other elements (members, attributes, etc), using the same style as for
\param or \return, i.e. with bold type explicit name (Detailed description) and
content indentation, for example:
Parameters
[in] argc count of arguments.
[in] argv array of pointer to strings.
Returns
If successful, it returns a pointer to a zero terminating string
containing
the file name. It returns nulptr if not found.
Detailed description
Process the command line parameters. If -j filename is encountered, a
pointer
to the given file name is returned. If errors occur, the process is
abruptly ended.
In some of my docs, in order to achieve similar results, I experimented with
/// \par Detailed description
///
/// \details
/// Process the command line parameters. If `-j filename` is
/// encountered, a pointer to the given file name is returned.
///
/// If errors occur, the process is abruptly ended.
/// ___
i.e. explicit \par with the name and explicit horizontal line to mark the end
of the section, but, in my oppinion, this is quite tedious.
The suggested implementation would need a new configuration variable, for
example
ALWAYS_MEMBER_DETAILED_SEC
eventually with the default set to NO, to not affect existing sites.
What do you think?
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
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
