You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@qpid.apache.org by Jonathan Robie <jo...@redhat.com> on 2009/01/28 23:17:47 UTC
Do we *need* the class hierarchy diagrams in the C++ doxygen?
I don't like the class hierarchy diagrams in the C++ doxygen html. I
think I can suppress them. This would reduce file size, and I think it
might make it easier to read.
Anyone want to tell me this would be a bad idea?
Jonathan
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Do we *need* the class hierarchy diagrams in the C++ doxygen?
Posted by Jonathan Robie <jo...@redhat.com>.
I just committed a version without graphics. Shout if you hate me for it.
Jonathan
Steve Huston wrote:
>> Jonathan Robie wrote:
>>
>>> I don't like the class hierarchy diagrams in the C++
>>>
>> doxygen html. I
>>
>>> think I can suppress them. This would reduce file size, and
>>>
>> I think it
>>
>>> might make it easier to read.
>>>
>>> Anyone want to tell me this would be a bad idea?
>>>
>>>
>> I'm responsible for putting those in - they seemed cool at
>> the time. They're probably not adding much value so if you
>> think its more readable without, and given the huge size, I'd
>> say go ahead and take them out. We can put them back if
>> there's widespread uproar, I suspect there won't be. People
>> who feel strongly can always generate their own customized
>> doxygen.
>>
>
> Right - for users, the only time they really add benefit is when the
> method you think you want is in an ancestor of the class you're
> reading and it's nice to have a map of where to look next. That's
> somewhat of an issue with qpid, but not such a big deal that the space
> is worth it, IMO.
>
> -Steve
>
>
> ---------------------------------------------------------------------
> Apache Qpid - AMQP Messaging Implementation
> Project: http://qpid.apache.org
> Use/Interact: mailto:dev-subscribe@qpid.apache.org
>
>
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
RE: Do we *need* the class hierarchy diagrams in the C++ doxygen?
Posted by Steve Huston <sh...@riverace.com>.
> Jonathan Robie wrote:
> > I don't like the class hierarchy diagrams in the C++
> doxygen html. I
> > think I can suppress them. This would reduce file size, and
> I think it
> > might make it easier to read.
> >
> > Anyone want to tell me this would be a bad idea?
> >
> I'm responsible for putting those in - they seemed cool at
> the time. They're probably not adding much value so if you
> think its more readable without, and given the huge size, I'd
> say go ahead and take them out. We can put them back if
> there's widespread uproar, I suspect there won't be. People
> who feel strongly can always generate their own customized
> doxygen.
Right - for users, the only time they really add benefit is when the
method you think you want is in an ancestor of the class you're
reading and it's nice to have a map of where to look next. That's
somewhat of an issue with qpid, but not such a big deal that the space
is worth it, IMO.
-Steve
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org
Re: Do we *need* the class hierarchy diagrams in the C++ doxygen?
Posted by Alan Conway <ac...@redhat.com>.
Jonathan Robie wrote:
> I don't like the class hierarchy diagrams in the C++ doxygen html. I
> think I can suppress them. This would reduce file size, and I think it
> might make it easier to read.
>
> Anyone want to tell me this would be a bad idea?
>
I'm responsible for putting those in - they seemed cool at the time. They're probably not adding much value so if you
think its more readable without, and given the huge size, I'd say go ahead and take them out. We can put them back if
there's widespread uproar, I suspect there won't be. People who feel strongly can always generate their own customized
doxygen.
Cheers,
Alan.
---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project: http://qpid.apache.org
Use/Interact: mailto:dev-subscribe@qpid.apache.org