Re: [Doxygen-users] Doxygen .txt file inclusion

[Paul J. <pau...@gm...>]

Thomas,

I frequently inlcuded doxygen marked up documentation in a file with a dox
extension and that was automatically picked up by Doxygen (last tried with
1.8.0).   The documentation does have to be enclosed in a doxygen comment
block but

/**
  Your comment here
*/

Would this suit your needs.

Paul


On Mon, Jan 6, 2014 at 8:50 AM, Thomas Nemeth <nem...@gm...>wrote:

> Hi Albert.
>
>     I'm sorry not beeing clear enough :(
>
>     I actually have a bunch of documentation in doxygen format in a .txt
> file
>     and .h file that is modified to include that documentation each time I
> change
>     that documentation (using scripts/makefiles/...)
>
>     That is... Not for just 1 project, but for all of them.
>
>     What I would like to do is to have a special command just like
> \include but
>     that could include any file and treat it as a doxygen documentation
> block.
>
>     I had a look at EXTENSION_MAPPING but that does not do what I need
> (since it
>     remaps an extention to a language... and so all the files with the same
>     extension -- well I could also change .txt to something else
> obviously). And
>     I don't want to include documentation in yet another format such as
> markdown :)
>
>     If such a command does not exist, I'll give a try at extension
> mapping...
>
>     Thanks.
>
> Thomas.
>
>
> 2014/1/6 Albert <alb...@gm...>
>
>> Hi Thomas,
>>
>> It is not 100% clear what you want to achieve, but have you looked at
>> EXTENSION_MAPPING and at the markdown possibilities?
>>
>> Albert
>>
>>
>> On Mon, Jan 6, 2014 at 2:56 PM, Thomas Nemeth <nem...@gm...>wrote:
>>
>>>
>>>     Hi.
>>>
>>>     I'd like to include in my projects documentation, some doxygen
>>> documentation
>>>     that lies in a non-source-code file (eg: .txt). Up to new I had to
>>> manually
>>>     copy/paste (well, not really manually, but using head/cat/tail using
>>> a makefile)
>>>     into a .h file so that the titlepage and some general documentation
>>> is included.
>>>
>>>     However, this is a bit non portable. I've searched through the
>>> documentation to
>>>     know if a special command could include such a file. But all I could
>>> find is
>>>     \include which is like including code. But I'd like to include
>>> documentation
>>>     with \section, \subsection and all...
>>>
>>>     Is there anything like that ?
>>>
>>>
>>> Thomas.
>>>
>>> --
>>> | A: Yes.
>>> | >Q: Are you sure?
>>> | >>A: Because it reverses the logical flow of conversation.
>>> | >>>Q: Why is top posting frowned upon?
>>>
>>>
>>> ------------------------------------------------------------------------------
>>> Rapidly troubleshoot problems before they affect your business. Most IT
>>> organizations don't have a clear picture of how application performance
>>> affects their revenue. With AppDynamics, you get 100% visibility into
>>> your
>>> Java,.NET, & PHP application. Start your 15-day FREE TRIAL of
>>> AppDynamics Pro!
>>>
>>> http://pubads.g.doubleclick.net/gampad/clk?id=84349831&iu=/4140/ostg.clktrk
>>> _______________________________________________
>>> Doxygen-users mailing list
>>> Dox...@li...
>>> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>>>
>>>
>>
>
>
> --
> | A: Yes.
> | >Q: Are you sure?
> | >>A: Because it reverses the logical flow of conversation.
> | >>>Q: Why is top posting frowned upon?
>
>
> ------------------------------------------------------------------------------
> Rapidly troubleshoot problems before they affect your business. Most IT
> organizations don't have a clear picture of how application performance
> affects their revenue. With AppDynamics, you get 100% visibility into your
> Java,.NET, & PHP application. Start your 15-day FREE TRIAL of AppDynamics
> Pro!
> http://pubads.g.doubleclick.net/gampad/clk?id=84349831&iu=/4140/ostg.clktrk
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>


-- 
Paul W. Joireman
pau...@gm...

----------------------------------------------------------------
'Am I not destroying my enemies when I make friends of them? ."
-- Abraham Lincoln 1809-1865