headers
Asmund Ostvold | 2 Feb 2005 20:32
Face

Man pages for library functions

I posted a message on the user list asking if it was possible to get
separate man-page for each function(public) that a library offers.  I
did not get a answer. Does this functionality exist in Doxygen?

    Here is an example to show what I ma interested in doing.  His is
    a c file that implements some public functions for the API:

    In file ffff.c;
    -------
    /*! function foo do some thing
     * \param a Contains something
     * \param b Contains something else
     * \return something
     */
    int foo( int a, int b){

    }

    /*! function bar for something
     * \param a takes a size of something
     * \param b takes something
     * \return something
     */
    int bar( int a, int b ){
    //some code
    }
    ------

    What I want is two man-page (files) foo.3 and bar.3 not making a
    single man-page. Maybe with the possibility to say what .h file it
(Continue reading)

Permalink | Reply | 1 comment |
headers
Chris Croughton | 2 Feb 2005 20:44
Picon

Re: Man pages for library functions

On Wed, Feb 02, 2005 at 08:32:57PM +0100, Asmund Ostvold wrote:

>     What I want is two man-page (files) foo.3 and bar.3 not making a
>     single man-page. Maybe with the possibility to say what .h file it
>     is defined in.
> 
> How difficult do you think this would be to implement?  If it is not
> too difficult I am more then willing to contribute this functionality
> to the Doxygen frame work.
> 
> Is there any interest for this or is it only me that needs this?

I would be interested.  Nice to see that I'm not the only one still
doing man pages...

I'm not sure if this will make it to the Doxygen list, since SourceForge
hates my domain, which is why I'm copying to you directly.

Chris C

-------------------------------------------------------
This SF.Net email is sponsored by: IntelliVIEW -- Interactive Reporting
Tool for open source databases. Create drag-&-drop reports. Save time
by over 75%! Publish reports on the web. Export to DOC, XLS, RTF, etc.
Download a FREE copy at http://www.intelliview.com/go/osdn_nl
Permalink | Reply | 0 comments |
headers
Marcel Loose | 4 Feb 2005 10:08
Picon
Favicon

\verbinclude does not include verbatim

Hi,

I already submitted this to Bugzilla (
http://bugzilla.gnome.org/show_bug.cgi?id=165793 ), but the list of
unconfirmed and new items in Bugzilla it quite long; which makes me
wonder whether I should submit this bug here as well. Anyway, here is
comes.

The command \verbinclude does not include a file verbatim when source
file 
filtering is turned on. The attached files demonstrate this. The
doxybug.doc 
file describes the bug; the doxybug.h file is a standard "legacy"
header file 
which is filtered by the input filter slash2spanning.pl (a modified
version of 
the one that is on the Doxygen site).

Run doxygen using the supplied configuration file doxybug.cfg and look
at the 
generated HTML files.

It seems this bug was introduced in version 1.3, because 1.2.18 does
not show this behaviour.

I've been digging in the sources a bit -- pretty well organized -- and
probably
found the culprit in docparser.cpp, function readTextFileByName().

The following patch probably solves this bug -- note: this patch is for
(Continue reading)

Permalink | Reply | 0 comments |
headers
Randall, Larry | 7 Feb 2005 17:36
Picon
Favicon

Aliases

I have noticed that 1.3.8 and 1.4.x ignore the \n in an alias and start
on the same line as previous output.  Example:

 "rev = Revision \n" \
 "syn = Syntax \n" \

I have even tried:
 "lib = \n Library \n"

This produces:
	Library ImageConversion.lib 

When \lib and \syn are "stacked", these produce:
	Library ImageConversion.lib Syntax Test of Syntax and code
style:  static CBufferCopyListener* NewL(const RThread* aSubThread)  

Previous output was: 

	Library (bolded)
		ImageConversion.lib 

	Syntax  (bolded)
		Test of Syntax and code style:  static
CBufferCopyListener* NewL(const RThread* aSubThread)

Regards, 
Larry Randall  
OMAP(tm) Program Facilitation Office 

-------------------------------------------------------
(Continue reading)

Permalink | Reply | 1 comment |
headers
Dimitri van Heesch | 12 Feb 2005 19:15
Picon
Favicon

Re: Aliases

On Mon, Feb 07, 2005 at 10:36:28AM -0600, Randall, Larry wrote:
> I have noticed that 1.3.8 and 1.4.x ignore the \n in an alias and start
> on the same line as previous output.  Example:
> 
>  "rev = Revision \n" \
>  "syn = Syntax \n" \
> 
> I have even tried:
>  "lib = \n Library \n"
> 
> This produces:
> 	Library ImageConversion.lib 
> 
> When \lib and \syn are "stacked", these produce:
> 	Library ImageConversion.lib Syntax Test of Syntax and code
> style:  static CBufferCopyListener* NewL(const RThread* aSubThread)  
> 
> Previous output was: 
> 
> 	Library (bolded)
> 		ImageConversion.lib 
> 
> 	Syntax  (bolded)
> 		Test of Syntax and code style:  static
> CBufferCopyListener* NewL(const RThread* aSubThread)

To me this sounds like you want to define the aliases like this:
ALIASES                = "syn=\par Syntax:\n" \
                         "lib=\par Library:\n"
(Continue reading)

Permalink | Reply | 0 comments |

Gmane