Csound Csound-dev Csound-tekno Search About

[Cs-dev] Doxygen documentation

Date2011-06-07 16:18
FromJohn ff
Subject[Cs-dev] Doxygen documentation
Like Richard D my heart sinks when I see Doxygen "documentation".
But in the spirit of adventure I tried generatePdf=1 after a while

After screens of output suggesting someone an count I get

pdflatex --include-directory=doc/latex --interaction=nonstopmode --job-name=CsoundAPI doc/latex/refman.tex
pdflatex: unrecognized option '--include-directory=doc/latex'
pdflatex: unrecognized option '--job-name=CsoundAPI'
This is pdfTeX, Version 3.1415926-1.40.11 (TeX Live 2010)
 restricted \write18 enabled.
entering extended mode
! I can't find file `doc/latex/refman.tex'.
<*> doc/latex/refman.tex
                        
SO I no wiser and still not better informed.

==John ffitch

------------------------------------------------------------------------------
EditLive Enterprise is the world's most technically advanced content
authoring tool. Experience the power of Track Changes, Inline Image
Editing and ensure content is compliant with Accessibility Checking.
http://p.sf.net/sfu/ephox-dev2dev
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

Date2011-06-07 16:39
FromSteven Yi
SubjectRe: [Cs-dev] Doxygen documentation
Try running "doxygen" by itself in the csound5 directory.  After that,
check out the doc/html folder.  I think it's not so bad myself. :P

On Tue, Jun 7, 2011 at 11:18 AM, John ff  wrote:
> Like Richard D my heart sinks when I see Doxygen "documentation".
> But in the spirit of adventure I tried generatePdf=1 after a while
>
> After screens of output suggesting someone an count I get
>
> pdflatex --include-directory=doc/latex --interaction=nonstopmode --job-name=CsoundAPI doc/latex/refman.tex
> pdflatex: unrecognized option '--include-directory=doc/latex'
> pdflatex: unrecognized option '--job-name=CsoundAPI'
> This is pdfTeX, Version 3.1415926-1.40.11 (TeX Live 2010)
>  restricted \write18 enabled.
> entering extended mode
> ! I can't find file `doc/latex/refman.tex'.
> <*> doc/latex/refman.tex
>
> SO I no wiser and still not better informed.
>
> ==John ffitch
>
> ------------------------------------------------------------------------------
> EditLive Enterprise is the world's most technically advanced content
> authoring tool. Experience the power of Track Changes, Inline Image
> Editing and ensure content is compliant with Accessibility Checking.
> http://p.sf.net/sfu/ephox-dev2dev
> _______________________________________________
> Csound-devel mailing list
> Csound-devel@lists.sourceforge.net
> https://lists.sourceforge.net/lists/listinfo/csound-devel
>

------------------------------------------------------------------------------
EditLive Enterprise is the world's most technically advanced content
authoring tool. Experience the power of Track Changes, Inline Image
Editing and ensure content is compliant with Accessibility Checking.
http://p.sf.net/sfu/ephox-dev2dev
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net

Date2011-06-07 16:52
Fromjpff@cs.bath.ac.uk
SubjectRe: [Cs-dev] Doxygen documentation
> Try running "doxygen" by itself in the csound5 directory.  After that,
> check out the doc/html folder.  I think it's not so bad myself. :P
>

I did that; very unimpressed.  Reading the code is simpler that page after
page of HTML.

I still think we need documentation on how to use the API, in every
language it supports.  Prweviously I have attempted the Java and C++
versions and there was simply no indication how to do anything.

As I do not know Java, Python or Lua, and really dislike C++ I amhardly
the person to do anything about this except whinge as I have before.

At least in C I can read the code, or actually use CLI methods.

==John ff (aka Mr Growser)



------------------------------------------------------------------------------
EditLive Enterprise is the world's most technically advanced content
authoring tool. Experience the power of Track Changes, Inline Image
Editing and ensure content is compliant with Accessibility Checking.
http://p.sf.net/sfu/ephox-dev2dev
_______________________________________________
Csound-devel mailing list
Csound-devel@lists.sourceforge.net