Re: [Doxygen-users] Documenting access of global variables

[Michael K. <mko...@la...>]

With regards to this, I have a related question.  I am new to using 
Doxygen, so I hope this isn't too naive of a question.  I've wondered 
why there isn't any way to have simple user defined commands.  Or is 
there?  Did I just miss that part?  I thought it would be nice to have, 
in the config file, a simple list of commands you want.  Then they would 
just show up in bold above the function doco.  So instead of date, I 
could use \created or make up my own things.

Thanks,
Michael

Friedrich, Lars wrote:
> Hi,
>
> I would like to document which global variables are
> used by a function, so something like:
>
> /** This function bla's around
>     \param[in] test whatever
>     \???? globvar inits the variable with 0
> */
> void bla(int test)
> {
>  globvar = 0;
> }
>
> Okay, there are several solutions to just achieve this,
> but I also want that it looks like the normal \param section.
> I can fake a list but it never looks that much like the
> \param section and/or never has the easy to use \param style.
> The latest version f.e. looks like this:
>
> ///  \param[in,out]   pnInitStateMachine function parameter
> ///
> ///  \startglobparam
> ///  \globparam [in] \newcol \ref ATS_ucACmd \newcol ACmd received
> ///  \globparam [in] \newcol \ref ATS_stAddress \newcol CIA-style
> address
> ///  \globparam [in] \newcol \ref ATS_pstBuffer \newcol pointer to
> tInOutBuffer
> ///  \globparam [out] \newcol \ref ATS_nAResp \newcol CAResp to be
> transmitted
> ///  \globparam [out] \newcol \ref ATS_nAReason \newcol who needs a
> reason?
> ///  \globparam [out] \newcol \ref ATS_nErrorCode \newcol error
> condition
> ///  \endglobparam
>
> with aliases:
> "startglobparam=\par Parameters passed through global variables:\n<table
> border="0"
> cellspacing="2" cellpadding="0">" \
> "endglobparam=</tr></table>" \
> "globparam=<tr><td><tt>" \
> "newcol=</tt> &nbsp;</td><td>"
>
> But let's face it: This is ugly in the code and still painful to
> write (and invalid HTML due to an additional closing tag).
> I can misuse of course \param with wrong names right now, but
> then I get (of course) warnings about false parameter documentation.
>
> Anyone got some ideas?
> Maybe it would be possible to extend \param with the keyword global,
> like with in, out, i.e. \param[global,in].
>
>
> Best regards,
> Lars Friedrich
>
>
> -------------------------------------------------------
> This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
> for problems?  Stop!  Download the new AJAX search engine that makes
> searching your log files as easy as surfing the  web.  DOWNLOAD SPLUNK!
> http://sel.as-us.falkag.net/sel?cmd=k&kid3432&bid#0486&dat1642
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>