On Fri, Nov 07, 2003 at 09:34:10AM +0100, Ferdinand Prantl wrote:
> there is a tag @internal, which has a complementary option INTERNAL_DOCS:
>
> # The INTERNAL_DOCS tag determines if documentation
> # that is typed after a \internal command is included. If the tag is set
> # to NO (the default) then the documentation will be excluded.
> # Set it to YES to include the internal documentation.
>
> INTERNAL_DOCS = NO
>
> This tag can be inserted into the comments of members, which are not wanted
> to be seen in the reference of the public API. And it works, at least by
> me... :-)
>
Actualy, this is not exactly the problem we have. @internal hides whole member
of function. What we need is somehthing else.
Imagine a class
class AContainer
{
...
typedef detail::internal_iterator_class iterator;
...
};
Now, the member iterator is important, but we don't want a user to access the
detail::xxx class directly, so we want to disguise the detail type, but we
still want the show the 'iterator' memeber.
So the result should look like
class AContainer
{
...
typedef unspecified-type iterator;
...
};
Regards,
Pavol
-------------------------------------------------------
This SF.net email is sponsored by: SF.net Giveback Program.
Does SourceForge.net help you be more productive? Does it
help you create better code? SHARE THE LOVE, and help us help
YOU! Click Here: http://sourceforge.net/donate/
_______________________________________________
Boost-docs mailing list
[EMAIL PROTECTED]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
