[OpenWalnut-Dev] Configure Doxygen for external linking

[Sebastian Eichelbaum]

Hi

I will apply this soon. I guess tomorrow or on Monday.

Cheers.


-- 
Dipl.-Inf. Sebastian Eichelbaum

-- www.sebastian-eichelbaum.de
-- www.nemtics.com

Universität Leipzig
Institut für Informatik
Abteilung Bild- und Signalverarbeitung
PF 100920
D-04009 Leipzig


On Fri, 28 Nov 2014, Christof Pieloth wrote:

> Hi List,
> 
> I'm just about to write the API documentation for our toolbox. Due
> to the out-of-source development, the documentation has no link to
> the OpenWalnut classes. Doxygen provides a solution for external
> libraries:
> http://www.stack.nl/~dimitri/doxygen/manual/external.html
> 
> OpenWalnut just have to generate a tagfile for an external toolbox.
> If you want to use this approach, you can apply the appended diff.
> 
> Cheers,
> Christof
> 
> -- 
> Christof Pieloth, M.Sc.
> Wissenschaftlicher Mitarbeiter
> 
> HTWK Leipzig, University of Applied Sciences
> Laboratory for Biosignal Processing (LaBP)
> Eilenburger Str. 13
> 04317 Leipzig
> 
> tel:  +49 (0) 341 3076 3133
> fax:  +49 (0) 341 3076 853133
> email: pieloth 'at' labp.htwk-leipzig.de
> web: www.labp.htwk-leipzig.de
> 

> diff -r eb492062f07f .hgignore
> --- a/.hgignore	Tue Nov 18 11:29:57 2014 +0100
> +++ b/.hgignore	Fri Nov 28 11:51:38 2014 +0100
> @@ -10,6 +10,7 @@
>  ^doc/core/html
>  ^doc/developer/html
>  ^doc/developer/man
> +^doc/developer/developer.tag
>  ^doc/developer/doxyerror.log
>  ^doc/developer/designDocuments/openWalnutDesign.aux
>  ^doc/developer/designDocuments/openWalnutDesign.bbl
> diff -r eb492062f07f doc/developer/doxygenConfig
> --- a/doc/developer/doxygenConfig	Tue Nov 18 11:29:57 2014 +0100
> +++ b/doc/developer/doxygenConfig	Fri Nov 28 11:51:38 2014 +0100
> @@ -1322,7 +1322,7 @@
>  # When a file name is specified after GENERATE_TAGFILE, doxygen will create
>  # a tag file that is based on the input files it reads.
>  
> -GENERATE_TAGFILE       =
> +GENERATE_TAGFILE       = doc/developer/developer.tag
>  
>  # If the ALLEXTERNALS tag is set to YES all external classes will be listed
>  # in the class index. If set to NO only the inherited external classes

> _______________________________________________
> OpenWalnut-Dev mailing list
> OpenWalnut-Dev at lists.informatik.uni-leipzig.de
> http://lists.informatik.uni-leipzig.de/mailman/listinfo/openwalnut-dev
> 
> Archive: http://lists.informatik.uni-leipzig.de/pipermail/openwalnut-dev/