Updated pjlib docs

git-svn-id: https://svn.pjsip.org/repos/pjproject/trunk@48 74dad513-b988-da41-8d7b-12977e46ad98
19 years ago · ea6655e89a
parent 0c5fd34201
commit ea6655e89a
5 changed files with 54 additions and 25 deletions
--- a/RELNOTES.txt
+++ b/RELNOTES.txt
@ -1,21 +1,28 @@
-Version 0.3
+RELEASE NOTES
+
+Version 0.3-pre4
+Nov 13th, 2005
+====================================
+
 PJLIB
-	- Correct error reporting in the whole library. No more vague -1 errors!
-	- New super portable socket abstraction.
-	- Other headers were made super portable too.
-	- Ioqueue supports multiple pending operations in a single socket!
-	- No more floating point.
-	- Ported to new platforms:
-		- i386/linux kernel (!)
-		- Sparc/Solaris
-		- Alpha/Linux
+ - Correct error reporting in the whole library. No more vague -1 errors!
+ - New super portable socket abstraction.
+ - Other headers were made super portable too.
+ - Ioqueue supports multiple pending operations in a single socket!
+ - No more floating point.
+ - Ported to new platforms:
+    - i386/linux kernel (!)
+    - Sparc/Solaris
+    - Alpha/Linux
+
 PJSIP
-	- Correct error reporting in the whole library. No more -1 errors!
-	- Rewrote event, now much more readable.
-	- Per object tracing.
+  - Correct error reporting in the whole library. No more -1 errors!
+  - Rewrote event, now much more readable.
+  - Per object tracing.


 Version 0.2.9 - 2005/06/19
+====================================
 Core:
  - Moved authentication stuff to core.
 SIMPLE:
--- a/pjlib/docs/doxygen.cfg
+++ b/pjlib/docs/doxygen.cfg
@ -133,7 +133,7 @@ FULL_PATH_NAMES        = NO
 # only done if one of the specified strings matches the left-hand part of 
 # the path. It is allowed to use relative paths in the argument list.

-STRIP_FROM_PATH        = "c:\project\pjproject-0.3"
+STRIP_FROM_PATH        = "c:\project\pjproject"

 # The INTERNAL_DOCS tag determines if documentation 
 # that is typed after a \internal command is included. If the tag is set 
@ -494,7 +494,7 @@ HTML_OUTPUT            = html
 # each generated HTML page (for example: .htm,.php,.asp). If it is left blank 
 # doxygen will generate files with .html extension.

-HTML_FILE_EXTENSION    = .html
+HTML_FILE_EXTENSION    = .htm

 # The HTML_HEADER tag can be used to specify a personal HTML header for 
 # each generated HTML page. If it is left blank doxygen will generate a 
--- a/pjlib/docs/footer.html
+++ b/pjlib/docs/footer.html
@ -1,4 +1,9 @@
 </TD></TR>
 </TABLE>
+
+</td>
+</tr>
+</table>
+
 </BODY>
 </HTML>
--- a/pjlib/docs/header.html
+++ b/pjlib/docs/header.html
@ -3,8 +3,30 @@
 <title>PJLIB Documentation</title>
 <link href="doxygen.css" rel="stylesheet" type="text/css">
 </head><body>
-<A HREF="/">&lt;-- HOME</A><HR>

+<TABLE id="MainTable" cellSpacing="0" cellPadding="0" width="100%" border="0">
+<!-- First Row, PJPROJECT logo. -->
+<TR>
+    <TD>
+	<TABLE id="LogoTable" cellSpacing="0" cellPadding="0" width="100%" border="0">
+	    <TR>
+		<TD><a href="/" target="_top"><IMG src="/images/pjlogo.jpg" border="0"></a></TD>
+		<TD>&nbsp;</TD>
+		<TD>&nbsp;</TD>
+	    </TR>
+	</TABLE>
+    </TD>
+</TR>
+<!-- Second Row, a HR. -->
+<TR>
+    <td colspan="3"><hr noshade size="1">
+    </td>
+</TR>
+<!-- Third row, main contents. -->
+<TR>
+    <TD>
+
+<!-- Main doxygen content -->
 <TABLE border="0">
-  <TR><TD width="600" align="left">
+  <TR><TD width="800" align="left">

--- a/pjlib/include/pj/doxygen.h
+++ b/pjlib/include/pj/doxygen.h
@ -29,7 +29,7 @@
 * @section download_sec Download
 *
 * PJLIB and all documentation can be downloaded from 
- * http://www.bulukucing.org.
+ * http://www.pjproject.net.
 *
 *
 * @section how_to_use_sec About This Documentation
@ -237,11 +237,6 @@
 * from the system (see @ref PJ_TIMESTAMP).
 *
 *
- * @subsection lexical_scanner_sec Lexical Scanner
- *
- * A fast, small, top-down lexical scanner to create fully optimized
- * hand-written parser. See @ref PJ_SCAN for more info.
- *
 * @subsection data_struct_sec Various Data Structures
 *
 * Various data structures are provided in the library:
@ -257,7 +252,7 @@
 *
 * A convenient TRY/CATCH like construct to propagate errors, which by
 * default are used by the @ref PJ_POOL_GROUP "memory pool" and 
- * the @ref PJ_SCAN "scanner". The exception
+ * the lexical scanner in pjlib-util. The exception
 * construct can be used to write programs like below:
 *
 * <pre>
@ -393,7 +388,7 @@
 *
 * Enjoy using PJLIB!
 *
- * Benny Prijono < bennylp at bulukucing dot org >
+ * Benny Prijono < bennylp at pjproject dot net >
 */