Re: [Doxygen-users] FW: Doxygen-users digest, Vol 1 #73 - 10 msgs

[Victor A. W. Jr. <va...@ru...>]

gee, you don't want
argument_name  argument type
like Pascal also?

At Friday 2001/07/13 05:54, you wrote:



>Joe,
>
>I haven't looked at the code (I'm a bit under the thumb at work at the
>moment) but would it be possible (pretty please) while you are in there
>to examine the possiblilty of setting up formatting using a plugin
>approach ?
>
>For readability I would like the tool to document members in a
>pascal-like format ie
>
>         member_name   (args)   : return_value
>
>... so that for a member function we would have output looking like ...
>
>fn_name  | (                                   | : return_value
>          |   argument_type1  argument_name1,   |
>          |   argument_type2  argument_name2    |
>          |  )                                  |
>
>
>NB : The bar '|' symbol indicates the edge of an html table.
>
>This keeps all the member names in the left hand column which makes it
>very easy for the eye.
>Also as in your suggestion splitting the args onto separate lines makes
>for easy reading of the signature.
>
>
>The reason we want this is that some of our type names are very long so
>with the existing doxygen format ....
>
>return_type  | fn_name (argument_type1  argument_name1, argument_type2
>argument_name2 )
>
>.... the fn_name and args are pushed right across the page and it
>quickly becomes cluttered and a unreadable.
>
>
>After all its documentation and if its not easily readable then its not
>much use.
>
>
>If a plugin approach were used then it would simplify the task of
>format customisation in future.
>
>Cheers JL
>
>
>
>Message: 9
>From: joe bester <be...@mc...>
>To: Dimitri van Heesch <di...@st...>
>Date: Thu, 12 Jul 2001 12:32:57 -0500
>Cc: Dox...@li...
>Subject: [Doxygen-users] Customizing look in Doxygen
>Reply-To: dox...@li...
>
>Dimitri,
>
>I've done some work to customize the output of doxygen to match our
>project's
>web design, and coding standard. Much of this has been accomplished via
>style
>sheets, but there some things, such as the format of function
>signatures have
>been necessary to handle as source code modifications.
>
>For example, we prefer to have functions displayed like this:
>
>return_type
>function_name(
>     argument_type1                    argument_name1,
>     argument_type2                    argument_name2)
>
>Rather than doxygen's default
>
>return_type function_name(argument_type1 argument_name1,
>argument_type2,
>argument_name2)
>
>This is mostly because we tend to have rather long function
>names and argument types.
>
>If I were to submit a patch to do this sort of formattting, would it be
>accepted? Perhaps if I wrapped it in a configuration option?
>
>joe
>
>
>
>Visit our website at http://www.ubswarburg.com
>
>This message contains confidential information and is intended only
>for the individual named.  If you are not the named addressee you
>should not disseminate, distribute or copy this e-mail.  Please
>notify the sender immediately by e-mail if you have received this
>e-mail by mistake and delete this e-mail from your system.
>
>E-mail transmission cannot be guaranteed to be secure or error-free
>as information could be intercepted, corrupted, lost, destroyed,
>arrive late or incomplete, or contain viruses.  The sender therefore
>does not accept liability for any errors or omissions in the contents
>of this message which arise as a result of e-mail transmission.  If
>verification is required please request a hard-copy version.  This
>message is provided for informational purposes and should not be
>construed as a solicitation or offer to buy or sell any securities or
>related financial instruments.
>
>
>_______________________________________________
>Doxygen-users mailing list
>Dox...@li...
>http://lists.sourceforge.net/lists/listinfo/doxygen-users

Victor A. Wagner, Jr.
PGP RSA fingerprint = 4D20 EBF6 0101 B069 3817 8DBF C846 E47A
PGP D-H fingerprint = 98BC 65E3 1A19 43EC 3908 65B9 F755 E6F4 63BB 9D93
The five most dangerous words in the English language:
               "There oughta be a law"