RE: [Doxygen-users] 3 feature requests

[Kremer, A. <ale...@in...>]

Hi all,

I have a related question maybe a feature enhancement,
I'd like to implement myself, but I need some pointer.

\bug, \todo, etc. cannot appear within the function
body (implementation). I would be nice to be able to put
a \bug report or a \todo on the exact spot in the
code where it happens.

When I tried to do it, I got a reference to
a function/method/variable/... following the body.
 and not the current one.
(if it is the last function it ignores it completely)

Example:

f() {
	//some code
	/** \bug the following is some buggy code */
	//some buggy code
	...
}

g() { // function that follows f()
=09
}

The actual \bug will be referring g() and not f().

Can anyone familiar with the Doxygen code point me
on how to solve this. It would be a very nice feature
for code-reviewing if you could just annotate the problematic
code within the body and get a nice reference list
that pinpoints all the problems...

kreso


| -----Original Message-----
| From: Cyrille Ch=E9p=E9lov [mailto:cy...@so...]
| Sent: Mon, January 07, 2002 12:18 PM
| To: dox...@li...
| Subject: [Doxygen-users] 3 feature requests
|=20
|=20
| Hi all, and thanks for the wonderful tool...
|=20
| I would love to see three features:
|=20
|     1) Ability to define new tags like \todo and \test, in=20
| the doxygen.cfg,
| like \security (eg. to leave out notes about areas to=20
| re-audit). Ideally,
| whenever such administrator-defined tags are encountered, the=20
| text would be
| accumulated to a
| new page (also defined in the doxygen.cfg) and shown on the =
"associate
| pages" list.
|=20
|     2) Ability to limit the depth of collaboration graphs, by=20
| access type.
| Let's say I've got this:
|=20
| class VeryCommonHelper {
|    /* a dense forest of otherwise trivial attributes */
| };
|=20
| class SomeClass {
|    VeryCommonHelper& a_helper;
|    char          a_other;
|    AnotherClass  a_stuff;
| };
|=20
| I would like the ability to not display what's in=20
| VeryCommonHelper, unless
| I'm looking at VeryCommonHelper's collab graph. OTOH, I may=20
| be interested in
| having AnotherClass' graph be expanded in SomeClass' graph.=20
| Could it be done
| by a \tag in VeryCommonHelper's docstring ? Like an array of=20
| options like
| \hide${i}InDeepGraph (with i in "Private", "Protected",=20
| "Public", "Base",
| "All").
|=20
|     3) Nicer handling of template instanciations
|=20
| I've got a template class which looks a lot like ATL's CPtr:
| template<class T> class smptr { ... };
|=20
| it is used that way:
| typedef smptr<SomeClass> p_SomeClass;
|=20
| and then each time a smart pointer to SomeClass is needed,=20
| p_SomeClass is
| used.
|=20
| Problem is, if I look at the collab graph of :
|=20
| class SomeClassUser {
|   p_SomeClass a_sc;
| };
|=20
| I see this:
|         [smptr< SomeClass >]
|                ^
|                |
|         [SomeClassUser]
| which is fine.
|=20
| Now, when I click on smptr< SomeClass >, I get the collab=20
| graph of smptr< T
| >, which is fine but makes collab graph navigability harder.
|=20
| It would be extremely nice if there was YACO, which forced=20
| the construction
| of an intermediary "template instanciation" page, which would=20
| say (in the
| above case):
|    <h1>Template Instanciation Reference</h1>
|    Template class: smptr
|    Template argument T: SomeClass
|=20
| .. with of course, the relevant links. This'd be very sweet=20
| (even sweeter
| would be the ability to have the words "smptr" and=20
| "SomeClass" in the above
| collab graph link each to its page, but that is maybe a=20
| little too much to
| ask from GraphViz).
|=20
|=20
|=20
| Thanks a lot in advance !
|=20
|     -- Cyrille
|=20
|=20
|=20
| _______________________________________________
| Doxygen-users mailing list
| Dox...@li...
| https://lists.sourceforge.net/lists/listinfo/doxygen-users
|=20