From bd3314f42028938cca6ff1761bb3ee343e5d686c Mon Sep 17 00:00:00 2001
From: Benny Prijono <bennylp@teluu.com>
Date: Wed, 2 Nov 2005 13:06:17 +0000
Subject: Updated doxygen documentation

git-svn-id: http://svn.pjsip.org/repos/pjproject/main@8 74dad513-b988-da41-8d7b-12977e46ad98
---
 pjlib/include/pj/doxygen.h | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

(limited to 'pjlib')

diff --git a/pjlib/include/pj/doxygen.h b/pjlib/include/pj/doxygen.h
index 3f54f25f..9c32e4e2 100644
--- a/pjlib/include/pj/doxygen.h
+++ b/pjlib/include/pj/doxygen.h
@@ -433,6 +433,27 @@
  * subprojects. For example, to open the complete PJLIB workspace, open
  * <tt>pjlib.dsw</tt> in <tt>$PJPROJECT/pjlib/build</tt> directory.
  *
+ *
+ * @subsubsection config_site_create_vc_sec Create config_site.h
+ *
+ * The file <tt><b>$PJPROJECT/pjlib/include/pj/config_site.h</b></tt>
+ * is supposed to contain configuration that is specific to your site/target.
+ * This file is not part of PJLIB, so you must create it yourself. Normally
+ * you just need to create a blank file.
+ *
+ * The reason why it's not included in PJLIB is so that you would not accidently
+ * overwrite your site configuration.
+ *
+ * If you fail to do this, Visual C will complain with error like: 
+ *
+ * <b>"fatal error C1083: Cannot open include file: 'pj/config_site.h': No such file 
+ * or directory"</b>.
+ *
+ * @subsubsection build_vc_subsubsec Build the Projects
+ *
+ * Just hit the build button!
+ *
+ *
  * @subsection build_sys_install_unix_sec Make System
  *
  * For other targets, PJLIB provides a rather comprehensive build system
@@ -483,6 +504,7 @@
  \verbatim
    $ cd /home/user/pjproject         # <-- go to $PJPROJECT
    $ vi build.mak                    # <-- set build target etc
+   $ touch pjlib/include/pj/config_site.h
    $ cd pjlib/build                  # <-- go to projet's build dir
    $ make                            # <-- build the project
  \endverbatim
@@ -564,6 +586,17 @@
  *    part of Linux kernel.
  *  - <tt>os-win32.mak</tt>: rules when target OS is Win32.
  *
+ *
+ * @subsubsection config_site_create_sec Create config_site.h
+ *
+ * The file <tt><b>$PJPROJECT/pjlib/include/pj/config_site.h</b></tt>
+ * is supposed to contain configuration that is specific to your site/target.
+ * This file is not part of PJLIB, so you must create it yourself.
+ *
+ * The reason why it's not included in PJLIB is so that you would not accidently
+ * overwrite your site configuration.
+ *
+ *
  * @subsubsection invoking_make_sec Invoking make
  *
  * Normally, \a make is invoked in \c build directory under each project.
-- 
cgit v1.2.3