Tuesday, February 5, 2013

Documentation for libjingle and webrtc

Hello again InternetLand,

Below are some simple instructions to generate doxygen documentation for Libjingle/WebRTC. It took me a while to figure this out and hopefully this can help someone save some time.

1. Get code from google code


svn checkout http://libjingle.googlecode.com/svn/trunk/ libjingle-read-only


2. Create docs folder and create doxygen file "libjingle.doxy" with the following configurations

INPUT = talk/app talk/base talk/media talk/p2p talk/session talk/sound talk/xmllite talk/xmpp talk/examples

FILE_PATTERNS = *.cc *.h

RECURSIVE = YES

EXCLUDE_PATTERNS = *_unittest.cc

EXTRACT_ALL = YES

SOURCE_BROWSER = YES

INLINE_SOURCES = YES

REFERENCED_BY_RELATION = YES

3. Run doxygen on the configuration

doxygen docs/libjingle.doxy


Enjoy.


INPUT = talk/app talk/base talk/media talk/p2p talk/session talk/sound talk/xmllite talk/xmpp talk/examples

FILE_PATTERNS = *.cc *.h

RECURSIVE = YES

EXCLUDE_PATTERNS = *_unittest.cc

EXTRACT_ALL = YES

SOURCE_BROWSER = YES

INLINE_SOURCES = YES

REFERENCED_BY_RELATION = YES

No comments:

Post a Comment