[prev in list] [next in list] [prev in thread] [next in thread] 

List:       doxygen-users
Subject:    [Doxygen-users] Make mentions of formal parameter names more obvious
From:       John Yates <john () yates-sheets ! org>
Date:       2014-05-07 17:01:52
Message-ID: CAJnXXohwawjOexr-GWVvhbYY6LzoMc-r_uo22bNLtJZraydUug () mail ! gmail ! com
[Download RAW message or body]

[Attachment #2 (multipart/alternative)]


I use \p to mark mentions of formal parameters.  The manual suggests that
this is indeed \p's intented role ("You can use this command to refer to
member function parameters in the running text").  Unfortunately that same
manual also supplies an excessively specific operational description of
\p's effect ("Displays the parameter <word> using a typewriter font. ... To
have multiple words in typewriter font use <tt>multiple words</tt>").
 Worse, based on this operational description it asserts equivalence
between \p and \c ("Equivalent to \c").

My generated documentation uses sans serif fonts for both proportional and
fixed width.  Changing to typewriter is too subtle to clearly call out a
token as a formal parameter name.  I would like to see \p more strongly
tied to marking formal parameters.  In particular I suggest rendering
marked up parameter names using the same font, bolding and color as when
they appears in a function signature.

/john

[Attachment #5 (text/html)]

<div dir="ltr">I use \p to mark mentions of formal parameters.   The manual suggests \
that this is indeed \p&#39;s intented role (&quot;You can use this command to refer \
to member function parameters in the running text&quot;).   Unfortunately that same \
manual also supplies an excessively specific operational description of \p&#39;s \
effect (&quot;Displays the parameter &lt;word&gt; using a typewriter font. ... To \
have multiple words in typewriter font use &lt;tt&gt;multiple \
words&lt;/tt&gt;&quot;).   Worse, based on this operational description it asserts \
equivalence between \p and \c (&quot;Equivalent to \c&quot;).<div> <br></div><div>My \
generated documentation uses sans serif fonts for both proportional and fixed width.  \
Changing to typewriter is too subtle to clearly call out a token as a formal \
parameter name.   I would like to see \p more strongly tied to marking formal \
parameters.   In particular I suggest rendering marked up parameter names using the \
same font, bolding and color as when they appears in a function signature.<br> \
<br>/john<br></div></div>



------------------------------------------------------------------------------
Is your legacy SCM system holding you back? Join Perforce May 7 to find out:
&#149; 3 signs your SCM is hindering your productivity
&#149; Requirements for releasing software faster
&#149; Expert tips and advice for migrating your SCM now
http://p.sf.net/sfu/perforce

_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users


[prev in list] [next in list] [prev in thread] [next in thread]