[Live-devel] Live555 documentation generated by doxygen

[David Stegbauer]

Hi all,

the online documentation is available at
http://geraldine.fjfi.cvut.cz/~dstegbauer/live555/html/index.html

Source Doxyfile is available at
http://geraldine.fjfi.cvut.cz/~dstegbauer/live555/Doxyfile

Please do not mirror the live555 documentation from the web, it has 307MiB. If 
you would like to have it locally, grab the above mentioned Doxyfile, put it to 
live555 source directory, cd there and run doxygen. You have to have doxygen 
and graphviz installed.


Ross,

would you consider addition of Doxyfile to distribution? Would you accept 
changes in source which will convert the in-source documentation to doxygen 
compatible format?

For example
Boolean changeResponseHandler(unsigned cseq, responseHandler* 
newResponseHandler);
// Changes the response handler for the previously-performed command (whose 
operation returned "cseq").
// (To turn off any response handling for the command, use a 
"newResponseHandler" value of NULL.  This might be done as part
//  of an implementation of a 'timeout handler' on the command, for example.)
// This function returns True iff "cseq" was for a valid previously-performed 
command (whose response is still unhandled).

will change to something like

//! Change the response handler for the previously-performed command.
//! \param cseq CSeq of the previously-performed command
//! \param newResponseHandler new response handler function.
//!     Set to null to turn off any response handling for the command.
//!     (This might be done as part of an implementation of a 'timeout 
handler' on the command, for example.)
//! \return True iff "cseq" was for a valid previously-performed command (whose 
response is still unhandled).
Boolean changeResponseHandler(unsigned cseq, responseHandler* 
newResponseHandler);


Best Regards
David Stegbauer

This e-mail and any attachment is for authorised use by the intended recipient(s) only. It may contain proprietary material, confidential information and/or be subject to legal privilege. It should not be copied, disclosed to, retained or used by, any other party. If you are not an intended recipient then please promptly delete this e-mail and any attachment and all copies and inform the sender. Thank you.