doxygen-users

[Doxygen-users] Problem with documenting generic parameter contraints in c#

[Steen M. <st...@db...>]

Hi.

We have a problem generating dokumentation from certain generic classes 
in our code base.
The problem consists of getting doxygen to show the parameter contraints 
from the C# code:

C# example:

using System;
using System.Collections.Generic;
public sealed class GenericsTest{

  public List<T> GenericList <T>() where T:IDisposable{
    return new List<T>();
  }

}

This will show up in the documentation as:

Public Member Functions
List< T > GenericList <cid:par...@db...> () where T


Thereby stripping the documentation of the information that the class 
itself is generic (the "GenericList<T>" bit) as well as the information 
on the parameter constraints(the "where T: IDisposable" bit)

This looks like a neglection in the parsing of the c# source, which I 
would be happy to provide a patch to, if I was able to find my way 
through the doxygen code...

Pointers, solutions or ideas are most welcome!

Best regards,
Steen Manniche
Danish Library Centre

[Doxygen-users] Changing the Doxygen CSS file...

[Emily B. <em...@ar...>]

I would like to add some class descriptions to the .css file Doxygen generates.

My theory is that manually changing the .css file in the generated directories is not going to work.

What do you think?

Thanks in advance.

-- Emily

Emily Berk
http://www.armadillosoft.com

Re: [Doxygen-users] Changing the Doxygen CSS file...

[Irwin D. <ir...@ca...>]

Emily,
You can create a stylesheet and call it something like doxygen.css by
running Doxygen using the following command:

  doxygen -w html header.html footer.html doxygen.css

This produces header, footer, and css files using the default Doxygen
values. You can then edit doxygen.css and point to it in your Doxygen
configuration file using:

  HTML_STYLESHEET =3D doxygen.css

You can simply discard the default header and footer files if you don't
need them.

Hope it helps.

-Irwin Diehl=20

-----Original Message-----
From: dox...@li...
[mailto:dox...@li...] On Behalf Of Emily
Berk
Sent: Thursday, May 24, 2007 10:24 AM
To: dox...@li...
Subject: [Doxygen-users] Changing the Doxygen CSS file...

I would like to add some class descriptions to the .css file Doxygen
generates.

My theory is that manually changing the .css file in the generated
directories is not going to work.

What do you think?

Thanks in advance.

-- Emily

Emily Berk
http://www.armadillosoft.com



------------------------------------------------------------------------
-
This SF.net email is sponsored by DB2 Express Download DB2 Express C -
the FREE version of DB2 express and take control of your XML. No limits.
Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: [Doxygen-users] Problem with documenting generic parameter contraints in c#

[Steen M. <st...@db...>]

Sorry for the typo, the part in the generated documentation where it 
reads "<cid:part1...>" should not have shown... The correct rendering 
should be (in its complete form):
List<T> GenericList() where T

 
Steen Manniche wrote:
> Hi.
>
> We have a problem generating dokumentation from certain generic classes 
> in our code base.
> The problem consists of getting doxygen to show the parameter contraints 
> from the C# code:
>
> C# example:
>
> using System;
> using System.Collections.Generic;
> public sealed class GenericsTest{
>
>   public List<T> GenericList <T>() where T:IDisposable{
>     return new List<T>();
>   }
>
> }
>
> This will show up in the documentation as:
>
> Public Member Functions
> List< T > GenericList () where T
>
>
> Thereby stripping the documentation of the information that the class 
> itself is generic (the "GenericList<T>" bit) as well as the information 
> on the parameter constraints(the "where T: IDisposable" bit)
>
> This looks like a neglection in the parsing of the c# source, which I 
> would be happy to provide a patch to, if I was able to find my way 
> through the doxygen code...
>
> Pointers, solutions or ideas are most welcome!
>
> Best regards,
> Steen Manniche
> Danish Library Centre
>
>
> -------------------------------------------------------------------------
> This SF.net email is sponsored by DB2 Express
> Download DB2 Express C - the FREE version of DB2 express and take
> control of your XML. No limits. Just data. Click to get it now.
> http://sourceforge.net/powerbar/db2/
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>   

Re: [Doxygen-users] =?iso-8859-1?q?Problem_with_documenting_generic_p?= =?iso-8859-1?q?arameter=09contraints_in_c=23?=

[Steen M. <st...@db...>]

Pardons for the *BUMP*

After you all have had some summer sun in which to think about this little 
nagging obstruction, I wondered if any of you did come up with an answer or 
perhaps just a little bit of info or pointers?

Best regards,
Steen


On Friday 25 May 2007 09:47, Steen Manniche wrote:
> Sorry for the typo, the part in the generated documentation where it
> reads "<cid:part1...>" should not have shown... The correct rendering
> should be (in its complete form):
> List<T> GenericList() where T
>
> Steen Manniche wrote:
> > Hi.
> >
> > We have a problem generating dokumentation from certain generic classes
> > in our code base.
> > The problem consists of getting doxygen to show the parameter contraints
> > from the C# code:
> >
> > C# example:
> >
> > using System;
> > using System.Collections.Generic;
> > public sealed class GenericsTest{
> >
> >   public List<T> GenericList <T>() where T:IDisposable{
> >     return new List<T>();
> >   }
> >
> > }
> >
> > This will show up in the documentation as:
> >
> > Public Member Functions
> > List< T > GenericList () where T
> >
> >
> > Thereby stripping the documentation of the information that the class
> > itself is generic (the "GenericList<T>" bit) as well as the information
> > on the parameter constraints(the "where T: IDisposable" bit)
> >
> > This looks like a neglection in the parsing of the c# source, which I
> > would be happy to provide a patch to, if I was able to find my way
> > through the doxygen code...
> >
> > Pointers, solutions or ideas are most welcome!
> >
> > Best regards,
> > Steen Manniche
> >
> >
> > -------------------------------------------------------------------------
> > This SF.net email is sponsored by DB2 Express
> > Download DB2 Express C - the FREE version of DB2 express and take
> > control of your XML. No limits. Just data. Click to get it now.
> > http://sourceforge.net/powerbar/db2/
> > _______________________________________________
> > Doxygen-users mailing list
> > Dox...@li...
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
> -------------------------------------------------------------------------
> This SF.net email is sponsored by DB2 Express
> Download DB2 Express C - the FREE version of DB2 express and take
> control of your XML. No limits. Just data. Click to get it now.
> http://sourceforge.net/powerbar/db2/
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users

-- 
Steen Manniche, Programmer.
DanishBibliographicCentre 
Tempovej 7-11
2750 DK-Ballerup

Re: [Doxygen-users] Problem with documenting generic parameter contraints in c#

[Dimitri v. H. <do...@gm...>]

Hi Steen,

Doxygen does not (properly) support generic methods with type constraints at
the moment.

I'm trying to improve the C# parsing whenever problems are found. I do not
use C# myself
so I rely on others to find and report problems. Please report them to the
bug tracker if you
find them along with an example.

I'm currently looking into the issue you reported and trying to improve the
parser.
Type constraints are a new "concept" in doxygen so this will need some work.

Regards,
  Dimitri


On 7/17/07, Steen Manniche <st...@db...> wrote:
>
> Pardons for the *BUMP*
>
> After you all have had some summer sun in which to think about this little
> nagging obstruction, I wondered if any of you did come up with an answer
> or
> perhaps just a little bit of info or pointers?
>
> Best regards,
> Steen
>
>
> On Friday 25 May 2007 09:47, Steen Manniche wrote:
> > Sorry for the typo, the part in the generated documentation where it
> > reads "<cid:part1...>" should not have shown... The correct rendering
> > should be (in its complete form):
> > List<T> GenericList() where T
> >
> > Steen Manniche wrote:
> > > Hi.
> > >
> > > We have a problem generating dokumentation from certain generic
> classes
> > > in our code base.
> > > The problem consists of getting doxygen to show the parameter
> contraints
> > > from the C# code:
> > >
> > > C# example:
> > >
> > > using System;
> > > using System.Collections.Generic;
> > > public sealed class GenericsTest{
> > >
> > >   public List<T> GenericList <T>() where T:IDisposable{
> > >     return new List<T>();
> > >   }
> > >
> > > }
> > >
> > > This will show up in the documentation as:
> > >
> > > Public Member Functions
> > > List< T > GenericList () where T
> > >
> > >
> > > Thereby stripping the documentation of the information that the class
> > > itself is generic (the "GenericList<T>" bit) as well as the
> information
> > > on the parameter constraints(the "where T: IDisposable" bit)
> > >
> > > This looks like a neglection in the parsing of the c# source, which I
> > > would be happy to provide a patch to, if I was able to find my way
> > > through the doxygen code...
> > >
> > > Pointers, solutions or ideas are most welcome!
> > >
> > > Best regards,
> > > Steen Manniche
> > >
> > >
> > >
> -------------------------------------------------------------------------
> > > This SF.net email is sponsored by DB2 Express
> > > Download DB2 Express C - the FREE version of DB2 express and take
> > > control of your XML. No limits. Just data. Click to get it now.
> > > http://sourceforge.net/powerbar/db2/
> > > _______________________________________________
> > > Doxygen-users mailing list
> > > Dox...@li...
> > > https://lists.sourceforge.net/lists/listinfo/doxygen-users
> >
> >
> -------------------------------------------------------------------------
> > This SF.net email is sponsored by DB2 Express
> > Download DB2 Express C - the FREE version of DB2 express and take
> > control of your XML. No limits. Just data. Click to get it now.
> > http://sourceforge.net/powerbar/db2/
> > _______________________________________________
> > Doxygen-users mailing list
> > Dox...@li...
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
> --
> Steen Manniche, Programmer.
> DanishBibliographicCentre
> Tempovej 7-11
> 2750 DK-Ballerup
>
>
> -------------------------------------------------------------------------
> This SF.net email is sponsored by DB2 Express
> Download DB2 Express C - the FREE version of DB2 express and take
> control of your XML. No limits. Just data. Click to get it now.
> http://sourceforge.net/powerbar/db2/
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>