As a long time fan of cross references, I enabled them on my docs, and I'm 
quite happy with content.

However, I have some suggestions regarding the presentation.

I would be happy to see an explicit section name equivalent to \par Cross 
references just before the cross section lines.

In some of my docs, in order to achieve similar results, I experimented with

      /// \par Detailed description
      ///
      /// \details
      /// Call the system function to write a sequence of bytes to the
      /// given file.
      /// \par Cross references

i.e. a manually added \par at the end of the \details section, but, in my 
oppinion, none of the \par lines should be there, since they have to do with 
presentation, not with content.

The suggested implementation would need a new configuration variable, for 
example

        ALWAYS_CROSS_REFERENCE_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
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Reply via email to