On Thursday 02 October 2003 08:46 am, Pavol Droba wrote:
> I want to have a link to the main reference page and also I'd like to be
> able to link to a spcific header.
>
> <example>
>
> <link linkend="reference">reference</link>
> <!-- and something like this -->
> <headername>boost/string_algo/regex.hpp</headername>
>
> </example>
>
> Is it possible? How?
For the second part, like this:
<headername>boost/string_algo/regex.hpp</headername>
:)
For the first part, well, that's a bit of undocumented voodoo. If you give you
<library> element an id attribute (in the top-level string_algo.xml file),
the id of the reference will be that id value plus ".reference". So if you
add, e.g., id="string_algo", you can link to the reference via <link
linkend="string_algo.reference">...</link>. This behavior won't change, so
you can rely on it, and it may eventually be documented. If we find that we
need to link directly to the reference sections often, we can figure out
something less hackish.
> Also I'm using <functionname> tag to link to a specific function.
> Unfortunately, this does not work if there is more then one overload of the
> function with the same name.
Have you considered putting your overloaded functions together? That's how the
C++ standard documents things. Just use \overload in Doxygen and it should
work (at least, it does for tribool, and the result is pretty nice).
> My last question is, if it is somehow possible to create a link from
> generated reference to the main docs. ( some doxygen tag? ).
I have no idea how to handle this: any ideas are welcome! Perhaps with
\xmlonly and some passthrough support we could get this working, but maybe
there's a better solution out there.
Doug
-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
_______________________________________________
Boost-docs mailing list
[EMAIL PROTECTED]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
