structs shown under 'classes'

View: New views
5 Messages — Rating Filter:   Alert me  

structs shown under 'classes'

by Jordi Benaiges :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Hi!

I'm starting with doxygen and I'm using doxygen frontend for windows,
doxygen at version 1.6.1.

I'm using the default doxygen frontend values, except for
GENERATE_TREEVIEW which I've switched it to "ON".


The problem is that in the left panel, under my custom group 'group1',
structure 'myStruct' appear in the label "Classes", which I find it very
misleading.



A simple example,



///
/// @defgroup group1 group 1
/// first group
///


///
/// @ingroup group1
///
struct myStruct
{
        int dummy1;
};



gives me this "problem". I suppose it's not a problem but a feature...
so, is there any way that I can get "structures" and "classes" in my
group instead of mixing them?  (I've been looking and testing some
switches at the configuration file, but I haven't been able to find it)



Thanks in advance,
Jordi

------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
trial. Simplify your report design, integration and deployment - and focus on
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: structs shown under 'classes'

by René Staffen :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Hi.
Actually there is no much diffrence between a class or a struct.
So why should they not be in the same list.
I would be happy if typedefs also would be listed.

But maybe the page should be renamed from Classes to Datatypes


MfG,
René Staffen

Jordi Benaiges schrieb:

> Hi!
>
> I'm starting with doxygen and I'm using doxygen frontend for windows,
> doxygen at version 1.6.1.
>
> I'm using the default doxygen frontend values, except for
> GENERATE_TREEVIEW which I've switched it to "ON".
>
>
> The problem is that in the left panel, under my custom group 'group1',
> structure 'myStruct' appear in the label "Classes", which I find it very
> misleading.
>
>
>
> A simple example,
>
>
>
> ///
> /// @defgroup group1 group 1
> /// first group
> ///
>
>
> ///
> /// @ingroup group1
> ///
> struct myStruct
> {
> int dummy1;
> };
>
>
>
> gives me this "problem". I suppose it's not a problem but a feature...
> so, is there any way that I can get "structures" and "classes" in my
> group instead of mixing them?  (I've been looking and testing some
> switches at the configuration file, but I haven't been able to find it)
>
>
>
> Thanks in advance,
> Jordi
>
> ------------------------------------------------------------------------------
> Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
> trial. Simplify your report design, integration and deployment - and focus on
> what you do best, core application coding. Discover what's new with
> Crystal Reports now.  http://p.sf.net/sfu/bobj-july
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users@...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users



------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
trial. Simplify your report design, integration and deployment - and focus on
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: structs shown under 'classes'

by Dimitri van Heesch-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


On 11 nov 2009, at 11:25, René Staffen wrote:

> Hi.
> Actually there is no much diffrence between a class or a struct.
> So why should they not be in the same list.
> I would be happy if typedefs also would be listed.

You can turn typedefs of structs into "real" structs using
TYPEDEF_HIDES_STRUCT = YES

>
> But maybe the page should be renamed from Classes to Datatypes

Doxygen will actually do this if you use OPTIMIZE_OUTPUT_FOR_C = YES.
For C++ class and struct are indeed the same thing.

Regards,
   Dimitri

>
>
> MfG,
> René Staffen
>
> Jordi Benaiges schrieb:
>> Hi!
>>
>> I'm starting with doxygen and I'm using doxygen frontend for windows,
>> doxygen at version 1.6.1.
>>
>> I'm using the default doxygen frontend values, except for
>> GENERATE_TREEVIEW which I've switched it to "ON".
>>
>>
>> The problem is that in the left panel, under my custom group  
>> 'group1',
>> structure 'myStruct' appear in the label "Classes", which I find it  
>> very
>> misleading.
>>
>>
>>
>> A simple example,
>>
>>
>>
>> ///
>> /// @defgroup group1 group 1
>> /// first group
>> ///
>>
>>
>> ///
>> /// @ingroup group1
>> ///
>> struct myStruct
>> {
>> int dummy1;
>> };
>>
>>
>>
>> gives me this "problem". I suppose it's not a problem but a  
>> feature...
>> so, is there any way that I can get "structures" and "classes" in my
>> group instead of mixing them?  (I've been looking and testing some
>> switches at the configuration file, but I haven't been able to find  
>> it)
>>
>>
>>
>> Thanks in advance,
>> Jordi


------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
trial. Simplify your report design, integration and deployment - and focus on
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: structs shown under 'classes'

by René Staffen :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message



Dimitri Van Heesch schrieb:
> On 11 nov 2009, at 11:25, René Staffen wrote:
>
>> Hi.
>> Actually there is no much diffrence between a class or a struct.
>> So why should they not be in the same list.
>> I would be happy if typedefs also would be listed.
>
> You can turn typedefs of structs into "real" structs using
> TYPEDEF_HIDES_STRUCT = YES

i meant typdefs to elementary types.
Such as:

/**
 *  Used to represent world coordinates in Fixpoint.
 *  Scaling: 2^7 -> see WORLDCOORD_SHIFT
 *
 */
typedef sint32_t WorldCoord_t;

#define WORLDCOORD_SHIFT 7

but you may really consider this:

>> But maybe the page should be renamed from Classes to Datatypes


Regards,
René

>
> Doxygen will actually do this if you use OPTIMIZE_OUTPUT_FOR_C = YES.
> For C++ class and struct are indeed the same thing.
>
> Regards,
>    Dimitri
>
>>
>> MfG,
>> René Staffen
>>
>> Jordi Benaiges schrieb:
>>> Hi!
>>>
>>> I'm starting with doxygen and I'm using doxygen frontend for windows,
>>> doxygen at version 1.6.1.
>>>
>>> I'm using the default doxygen frontend values, except for
>>> GENERATE_TREEVIEW which I've switched it to "ON".
>>>
>>>
>>> The problem is that in the left panel, under my custom group  
>>> 'group1',
>>> structure 'myStruct' appear in the label "Classes", which I find it  
>>> very
>>> misleading.
>>>
>>>
>>>
>>> A simple example,
>>>
>>>
>>>
>>> ///
>>> /// @defgroup group1 group 1
>>> /// first group
>>> ///
>>>
>>>
>>> ///
>>> /// @ingroup group1
>>> ///
>>> struct myStruct
>>> {
>>> int dummy1;
>>> };
>>>
>>>
>>>
>>> gives me this "problem". I suppose it's not a problem but a  
>>> feature...
>>> so, is there any way that I can get "structures" and "classes" in my
>>> group instead of mixing them?  (I've been looking and testing some
>>> switches at the configuration file, but I haven't been able to find  
>>> it)
>>>
>>>
>>>
>>> Thanks in advance,
>>> Jordi
>
>
> ------------------------------------------------------------------------------
> Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
> trial. Simplify your report design, integration and deployment - and focus on
> what you do best, core application coding. Discover what's new with
> Crystal Reports now.  http://p.sf.net/sfu/bobj-july
> _______________________________________________
> Doxygen-users mailing list
> Doxygen-users@...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users



------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
trial. Simplify your report design, integration and deployment - and focus on
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Re: structs shown under 'classes'

by Jordi Benaiges :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Dimitri Van Heesch wrote:

> For C++ class and struct are indeed the same thing.

Well, while I agree with you and René (nowadays in C++ classes and
structs are about the same) I tend to use them in different ways despite
that fact.

In example, when I have to pass a ton of parameters to a function, I
create an struct type containing all the parameters to be passed.
Putting that structure into a 'classes' folder it's a bit misleading for
me.



Anyways after some days of use I'd like to reformulate my question :)

Is it possible to disable the class/function sorting in the modules
section by configuration switch?

I'll try to explain with an example because I'm terrible describing this
kind of things, so I won't even bother doing it ;)


I love the flexibility of doxygen with grouping and the tree-structure
"modules" in the left side, it is great to keep things sorted the way I
like with minimal effort. In order to overcome the "struct" issue and
other issues I've built an structure like this (you'll need a monospaced
font for my ascii "art")

+modules
|
|-- OpenGL wrapper
|   |
|   |-- structs (user)
|   |   |
|   |   |-- Classes  <--- :(
|   |       |
|   |       |- struct 1
|   |       |
|   |       |- struct 2
|   |
|   |-- structs (internal)
|   |
|   |-- classes
|   |
|   |-- functions
|   |
|   |-- local functions
|   |
|   |-- enums
|
|-- AI
|   + ....
.....
.....


and I use the @ingroup order to keep everything sorted to my choice.

However I don't like the fact that when I click "structs (user)" or
"structs (internal)" another level appears (classes) to be clicked in
order to get to the real data.

Is it possible to disable this behaviour, so that clicking "structs"
will directly appear the struct list instead of another tree node "classes"?

If it's not possible by switch, a little pointer to the doxygen code in
order to modify this behaviour would be also useful.


Thanks again! :)

Jordi

------------------------------------------------------------------------------
Let Crystal Reports handle the reporting - Free Crystal Reports 2008 30-Day
trial. Simplify your report design, integration and deployment - and focus on
what you do best, core application coding. Discover what's new with
Crystal Reports now.  http://p.sf.net/sfu/bobj-july
_______________________________________________
Doxygen-users mailing list
Doxygen-users@...
https://lists.sourceforge.net/lists/listinfo/doxygen-users