Hi FreeRDP developers,
I have started documenting entire source files using doxygen, as an effort
towards having good documentation for our source code. I did a first pass on
the following files:
libfreerdp/capabilities.c
libfreerdp/credssp.c
libfreerdp/ntlmssp.c
libfreerdp/datablob.c
libfreerdp/nego.c
libfreerdpgdi/libfreerdpgdi.c
libfreerdpgdi/gdi_window.c
In all cases where a function refers to something documented on MSDN, I have
added MSDN references. I have also documented the way MSDN URLs work:
http://www.freerdp.com/wiki/doku.php?id=msdn_referencing
For instance, you will see something like this:
/**
* Output bitmap capability set.\n
* Bitmap Capability Set (TS_BITMAP_CAPABILITYSET) @msdn{cc240554}
* @param rdp
* @param s
*/
void rdp_out_bitmap_capset(rdpRdp * rdp, STREAM s)
When doxygen generates the documentation, it will replace @msdn{cc240554}
by http://msdn.microsoft.com/en-us/library/cc240554/
@msdn{} is an alias that I have defined in the FreeRDP Doxyfile to simplify
referencing MSDN documentation.
For information on how to use doxygen, I have documented it here:
http://www.freerdp.com/wiki/doku.php?id=doxygen
I have also updated the Eclipse IDE wiki page for doxygen auto-completion
(very useful): http://www.freerdp.com/wiki/doku.php?id=eclipse
The generated documentation can be found here: http://www.freerdp.com/api/
I haven't had the time yet to automate the generation of the documentation
on the website, but I'll do it when I get the time.
------------------------------------------------------------------------------
Colocation vs. Managed Hosting
A question and answer guide to determining the best fit
for your organization - today and in the future.
http://p.sf.net/sfu/internap-sfd2d
_______________________________________________
Freerdp-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/freerdp-devel
