doxygen-develop

[Doxygen-develop] STL classes dummy header

[Martin S. <em...@no...>]

In response to the FAQ, question #15. Why are dependencies via STL classes =
not shown in the dot graphs?=0A=
>> I'm still looking for someone who can provide me with definitions for al=
l (relevant) STL classes.=0A=
=0A=
I've made a header file which covers the main STL classes (vector, deque, l=
ist, slist, set, map and pair).=0A=
=0A=
Hopefully it will be usefull to others as well... There are still some clas=
ses missing (multiset, multimap, hash_set, hash_map, hash_multiset, hash_mu=
ltimap). I don't think hash needs to be done since in the documentation it =
says "The hash<T> template is only defined for template arguments of type c=
har*, const char*, crope, wrope, and the built-in integral types."=0A=
=0A=
If somebody wants to take some time to add the missing classes, what i did =
was just go to:=0A=
http://www.sgi.com/tech/stl/table_of_contents.html=20=0A=
=0A=
there is a list of classes there... and if you click on each one there is a=
 description for the class. I've just cut and pasted that into the header f=
ile.=0A=
=0A=
One other thing, I didn't put the classes in the std namespace because in m=
y project "using namespace std;" is in my precompiled header file and doxyg=
en misses it. Leaving it as it is will cause problems for people using the =
stl classes like this "std::vector<MyClass>", rather than "using namespace =
std; vector<MyClass>". I would suggest if this is ever included in with dox=
ygen that the classes should be in the correct namespace. I'll just have to=
 go and add "using namespace std;" at the top of all my .h files.=0A=
=0A=
SpaceDude.=0A=
=0A=
=0A=
This message has been checked for viruses but the contents of an attachment=
=0A=
may still contain software viruses, which could damage your computer system:=
=0A=
you are advised to perform your own checks. Email communications with the=
=0A=
University of Nottingham may be monitored as permitted by UK legislation.=
=0A=
=0A=

Re: [Doxygen-develop] STL classes dummy header

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

Hi Martin,

The FAQ is somewhat outdated at this point. Recent versions
of doxygen have a config option BUILTIN_STL_SUPPORT.
This does not provide documentation for the STL classes however, so your
file still has an advantage.

Regards,
  Dimitri

On 9/22/06, Martin Sherburn <em...@no...> wrote:
>
> In response to the FAQ, question #15. Why are dependencies via STL classes
> not shown in the dot graphs?
> >> I'm still looking for someone who can provide me with definitions for
> all (relevant) STL classes.
>
> I've made a header file which covers the main STL classes (vector, deque,
> list, slist, set, map and pair).
>
> Hopefully it will be usefull to others as well... There are still some
> classes missing (multiset, multimap, hash_set, hash_map, hash_multiset,
> hash_multimap). I don't think hash needs to be done since in the
> documentation it says "The hash<T> template is only defined for template
> arguments of type char*, const char*, crope, wrope, and the built-in
> integral types."
>
> If somebody wants to take some time to add the missing classes, what i did
> was just go to:
> http://www.sgi.com/tech/stl/table_of_contents.html
>
> there is a list of classes there... and if you click on each one there is
> a description for the class. I've just cut and pasted that into the header
> file.
>
> One other thing, I didn't put the classes in the std namespace because in
> my project "using namespace std;" is in my precompiled header file and
> doxygen misses it. Leaving it as it is will cause problems for people using
> the stl classes like this "std::vector<MyClass>", rather than "using
> namespace std; vector<MyClass>". I would suggest if this is ever included in
> with doxygen that the classes should be in the correct namespace. I'll just
> have to go and add "using namespace std;" at the top of all my .h files.
>
> SpaceDude.
>
>
> This message has been checked for viruses but the contents of an
> attachment
> may still contain software viruses, which could damage your computer
> system:
> you are advised to perform your own checks. Email communications with the
> University of Nottingham may be monitored as permitted by UK legislation.
>
>
>
> -------------------------------------------------------------------------
> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the chance to share
> your
> opinions on IT & business topics through brief surveys -- and earn cash
> http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
>
> _______________________________________________
> Doxygen-develop mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-develop
>
>
>
>