Changeset 8


Ignore:
Timestamp:
Nov 2, 2005 1:06:17 PM (16 years ago)
Author:
bennylp
Message:

Updated doxygen documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • pjproject/main/pjlib/include/pj/doxygen.h

    r6 r8  
    434434 * <tt>pjlib.dsw</tt> in <tt>$PJPROJECT/pjlib/build</tt> directory. 
    435435 * 
     436 * 
     437 * @subsubsection config_site_create_vc_sec Create config_site.h 
     438 * 
     439 * The file <tt><b>$PJPROJECT/pjlib/include/pj/config_site.h</b></tt> 
     440 * is supposed to contain configuration that is specific to your site/target. 
     441 * This file is not part of PJLIB, so you must create it yourself. Normally 
     442 * you just need to create a blank file. 
     443 * 
     444 * The reason why it's not included in PJLIB is so that you would not accidently 
     445 * overwrite your site configuration. 
     446 * 
     447 * If you fail to do this, Visual C will complain with error like:  
     448 * 
     449 * <b>"fatal error C1083: Cannot open include file: 'pj/config_site.h': No such file  
     450 * or directory"</b>. 
     451 * 
     452 * @subsubsection build_vc_subsubsec Build the Projects 
     453 * 
     454 * Just hit the build button! 
     455 * 
     456 * 
    436457 * @subsection build_sys_install_unix_sec Make System 
    437458 * 
     
    484505   $ cd /home/user/pjproject         # <-- go to $PJPROJECT 
    485506   $ vi build.mak                    # <-- set build target etc 
     507   $ touch pjlib/include/pj/config_site.h 
    486508   $ cd pjlib/build                  # <-- go to projet's build dir 
    487509   $ make                            # <-- build the project 
     
    564586 *    part of Linux kernel. 
    565587 *  - <tt>os-win32.mak</tt>: rules when target OS is Win32. 
     588 * 
     589 * 
     590 * @subsubsection config_site_create_sec Create config_site.h 
     591 * 
     592 * The file <tt><b>$PJPROJECT/pjlib/include/pj/config_site.h</b></tt> 
     593 * is supposed to contain configuration that is specific to your site/target. 
     594 * This file is not part of PJLIB, so you must create it yourself. 
     595 * 
     596 * The reason why it's not included in PJLIB is so that you would not accidently 
     597 * overwrite your site configuration. 
     598 * 
    566599 * 
    567600 * @subsubsection invoking_make_sec Invoking make 
Note: See TracChangeset for help on using the changeset viewer.