Re: [Openquicktime-devel] HeaderDoc, API and oqtaudioextract

[Nicholas H. <nj...@ec...>]

Hi Yann,

I have tarziped the docs here:
http://lotto.st-andrews.ac.uk/~njh/openquicktime-docs.tgz
But here is how to generate them:

njh@lotto$ cd include/openquicktime/
njh@lotto$ headerdoc2html openquicktime.h

Processing openquicktime.h
...done


Documentation ends up in a directory called 'openquicktime' within 
the current directory.

More about HeaderDoc here:
http://www.opensource.apple.com/projects/headerdoc/


Cheers,

nj.



>OK, send me your documentation or explain me the syntax to generate it ;)
>and I will put it on the website ... and I think I will spend some time
>actualizing it as well ... hehehe ... it's really needed ;)
>
>Yann.
>
>----- Original Message -----
>From: "Nicholas Humfrey" <nj...@ec...>
>To: <ope...@li...>
>Sent: Sunday, April 07, 2002 1:12 AM
>Subject: [Openquicktime-devel] HeaderDoc, API and oqtaudioextract
>
>
>>
>>  Hello All,
>>
>>  I have finished doing HeaderDoc comments for the whole of the OQT
>>  public API (74 functions in total). The structures still need
>>  commenting some time... (less important I think). One of the main
>>  reasons I did it was because I kept wanting to refer to documentation
>>  myself and it helped me learn what is there...
>>  Should it go on the main website sometime Yann ?
>>
>>  While I was doing this I did a bit more standardization - in
>>  particular oqt_get_audio_XXX, oqt_set_audio_XXX etc...
>>  Oh and in case you didn't notice I renamed everything starting
>>  quicktime_ oqt_ - I think it makes it more clear that this is the
>>  OpenQuicktime API not a clone of QuickTime - and it is shorter :)
>>
>>  Oh and I wrote a little utility to decode the audio track from a
>>  movie and save it to .aiff. If anyone wants something else (.wav)
>>  then they will have to add it themselves - hehe :)
>>  I think that we should maybe include libsndfile into the project
>>  properly sometime (it is LGPL). Maybe just staticly linked to
>>  oqtencoder so that it can take in multiple audio formats... ?
>>
>>
>>  I had more of a play with 3ivX today - looking good guys :)
>>
>>
>>  nj.
>>
>>  _______________________________________________
>>  Openquicktime-devel mailing list
>>  Ope...@li...
>>  https://lists.sourceforge.net/lists/listinfo/openquicktime-devel
>>
>
>
>_______________________________________________
>Openquicktime-devel mailing list
>Ope...@li...
>https://lists.sourceforge.net/lists/listinfo/openquicktime-devel


-- 
Nicholas Humfrey

Undergraduate, BSc Computer Science
University of Southampton, UK
nj...@ec...
http://www.ecs.soton.ac.uk/~njh399/