Re: Referring to libstdc++

[Krzesimir Nowak <qdlacz gmail com>]

2013/10/11 fr33domlover <fr33domlover mailoo org>

Hello,

I'm writing software in C++, and I use Doxygen for API docs. I noticed
that mm-common comes with a doxygen file for libstdc++, so all mm-common
users (gtkmm, glibmm, etc.) can refer to it. But it seems to download
its own specific copy instead of having full shared docs for all C++
APIS to refer to, and allow the user access to full std namespace docs.

Is there a reason a doxygen doc package for libstdc++ is not shipped
with GNU/Linux distros? IIRC I saw HTML docs in Fedora, but they weren't
available from Devhelp. And in Debian I don't see such docs at all.

Hi,

Not sure if I understood your question correctly, but the reason mm-common downloads libstdc++ doxytags file from gcc.gnu.org is that there is no standard way of getting a path to a distro-specific copy of it. And adding distro-specific hacks for it is full of yuck.

 

I always use web resources for C++, and I'd like to have at least the C
++ standard library in Devhelp. http://cppreference.com is a good
example, I use it a lot. Having it as a package on the desktop would be
amazing, although having it alone doesn't allow immediately
cross-references.

I use GNOME 3.4.2 so maybe things changed since then. What is the recent
approach for referencing the std namespace in Doxygen and having the
whole libstdc++ doxygen docs visible in Devhelp?

As you may deduce from what I said - there's possibly no standard way of referencing std namespace in Doxygen (which boils down to pointing doxygen to libstdc++.tag).

As of libstdc++ and doxygen - devhelp is mostly for viewing docs generated by gtk-doc, not devhelp. But in mm-common there's a stylesheet tagfile-to-devhelp2.xsl, so in theory you could do something like this on Fedora 19:

xsltproc --stringparam book_title "libstdc++" --stringparam book_name "C++ standard library" --stringparam book_base "" -o libstdc++.devhelp2 tagfile-to-devhelp2.xsl /usr/share/doc/libstdc++-docs-4.8.2/html/api/libstdc++.tag

The resulting libstdc++.devhelp2 file should be put to /usr/share/devhelp/books/libstdc++ directory.

I haven't tried that though - never felt the need of it.

 

Thanks!
fr33domlover

_______________________________________________
gtkmm-list mailing list
gtkmm-list gnome org
https://mail.gnome.org/mailman/listinfo/gtkmm-list