Show
Ignore:
Timestamp:
02/21/05 23:13:09 (8 years ago)
Author:
minaguib
Message:

Documentation & URL updating

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/wifidog/doc/README.developers.txt

    r6 r472  
    22$Header$ 
    33 
     4 
    45This file contains some small notes on developing the WiFiDog application. 
    56 
    6 The application's home page is http://www.ilesansfil.org/wiki/WiFiDog 
    7 The application's sourceforge page is http://sourceforge.net/projects/wifidog/ 
     7The application's home page is: 
     8        http://www.ilesansfil.org/wiki/WiFiDog 
    89 
    9 As a developer, you must subscribe to sourceforge as a "developer" under WiFiDog, as well as subscribe to the WiFiDog mailing list located at http://isf.waglo.com/mailman/listinfo/wifidog_isf.waglo.com 
     10The application's sourceforge page is: 
     11        http://sourceforge.net/projects/wifidog/ 
     12 
     13As a developer, you must subscribe to sourceforge as a "developer" under WiFiDog, as well as subscribe to the WiFiDog mailing list located at: 
     14        http://listes.ilesansfil.org/cgi-bin/mailman/listinfo/wifidog 
     15 
    1016 
    1117SOURCE CODE: 
    … …  
    1925        - Before writing any brand-new large chunks of code, make sure it's logic has been discussed with the other team of developers or included in the design stage. 
    2026 
     27 
     28MEMORY ALLOCATION IN SOURCE CODE: 
     29        - Safe versions of C functions that allocate memory (safe_malloc, safe_asprintf, etc..) have been created in safe.c . You must use them instead of the original functions. 
     30        - If you need to use a memory-allocating C function that does not have a safe version in safe.c, create the safe wrapper first (following the template of the others) and use that instead of calling the original. 
     31 
     32 
    2133DOCUMENTATION: 
    2234        - Please use DoxyGen-style comments (see http://www.doxygen.org/ for details) for source code documentation. 
    2335        - Please use DocBook-SGML documentation for user documentation.  This will make it easy to export documentation in multiple formats.  Otherwise submit your documentation in plaintext format to someone who will change it to DocBook. 
    2436        - Please thoroughly-comment non-clear sections in your code. 
     37