On Sat, Oct 5, 2013 at 11:30 AM, <
doxygen-users-requ...@lists.sourceforge.net> wrote:
> Date: Mon, 23 Sep 2013 17:33:50 +0200
> From: Yura Vishnevskiy <yuri.vishnevs...@gmail.com>
> Subject: Re: [Doxygen-users] Public and private parts in documentation
>
> I have also another more general problem. My application itself is an
> interpreter for some script-like language (similar to Ruby). I would
> like to use Doxygen not only to document the internals in this
> interpreter but also to describe this mentioned script-like language in
> a way just like it is done in Ruby, i.e. information about core classes
> and their methods, modules, etc. is provided in the source files, where
> they are implemented. Thus, I would like to have in principle two
> independent layers (for the internals of the interpreter itself and for
> the language which it implements) of documentation in the same source
> files using Doxygen. What could the most optimal and elegant way to do
> this?
>
You could use the \internal directive to denote internals documentation and
the \cond directive for your language reference. Then in you Doxygen
configuration, you can control which group of sections is included in the
generated document.
------------------------------------------------------------------------------
October Webinars: Code for Performance
Free Intel webinars can help you accelerate application performance.
Explore tips for MPI, OpenMP, advanced profiling, and more. Get the most from
the latest Intel processors and coprocessors. See abstracts and register >
http://pubads.g.doubleclick.net/gampad/clk?id=60134071&iu=/4140/ostg.clktrk
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
