On Friday 07 November 2003 03:34 am, Ferdinand Prantl wrote:
> Hi,
>
> 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... :-)
>
> Ferda
The last time I checked, the @internal flag didn't affect the Doxygen XML
output, so there was no way to tell if a block was marked external. That's
why the Doxygen -> BoostBook transform has this obnoxious hack where it scans
for the string "INTERNAL ONLY" in the documentation, and surpresses the
function/class/whatever if the string is found. (See, for instance, the
"tribool" library in the YahooGroups file section).
Some day I hope to find the time to submit a Doxygen patch to fix some of
these oversights...
Doug
> > -----Original Message-----
> > From: Douglas Gregor [mailto:[EMAIL PROTECTED]
> > Sent: Friday, November 07, 2003 05:41
> > To: [EMAIL PROTECTED]
> > Subject: Re: [Boost-docs] feature request
> >
> > On Tuesday 04 November 2003 02:35 am, Pavol Droba wrote:
> > > Hi,
> > >
> > > During the review of the string_algo lib, one issue about the
> > > documentation has be risen.
> > >
> > > It is required to hide some implementation-details from the
> >
> > reference.
> >
> > > More specificaly, it is required that some types can be disgised as
> > > "implementation-defined".
> > >
> > > Is there a way how to do this in the doxygen-generated reference?
> > >
> > > Pavol.
> >
> > There isn't currently, but of course I'm open to suggestions.
> > Two possibilities come to mind:
> > - use the xmlonly tag and put some custom XML that says
> > "override foo with bar"
> > - Use some heuristic that checks, say, if "detail" is in
> > the type and then mutates the type to "unspecified"
> >
> > Haven't had much time to think about it, but it would be nice
> > to solve this issue...
> >
> > Doug
> >
> >
> >
> > -------------------------------------------------------
> > 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
>
> -------------------------------------------------------
> 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
-------------------------------------------------------
This SF.Net email sponsored by: ApacheCon 2003,
16-19 November in Las Vegas. Learn firsthand the latest
developments in Apache, PHP, Perl, XML, Java, MySQL,
WebDAV, and more! http://www.apachecon.com/
_______________________________________________
Boost-docs mailing list
[EMAIL PROTECTED]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
