Pretty comments

git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@51 74dad513-b988-da41-8d7b-12977e46ad98

5 files changed, 93 insertions, 171 deletions

diff --git a/pjlib-util/include/pjlib-util.h b/pjlib-util/include/pjlib-util.h
index 8efac78b..2def324b 100644
--- a/pjlib-util/include/pjlib-util.h
+++ b/pjlib-util/include/pjlib-util.h
@@ -1,23 +1,20 @@
+/* $Id */

 /* 

- * PJLIB - PJ Foundation Library

- * (C)2003-2005 Benny Prijono <bennylp@bulukucing.org>

+ * Copyright (C)2003-2006 Benny Prijono <benny@prijono.org>

  *

- * Author:

- *  Benny Prijono <bennylp@bulukucing.org>

+ * This program is free software; you can redistribute it and/or modify

+ * it under the terms of the GNU General Public License as published by

+ * the Free Software Foundation; either version 2 of the License, or

+ * (at your option) any later version.

  *

- * This library is free software; you can redistribute it and/or

- * modify it under the terms of the GNU Lesser General Public

- * License as published by the Free Software Foundation; either

- * version 2.1 of the License, or (at your option) any later version.

- * 

- * This library is distributed in the hope that it will be useful,

+ * This program is distributed in the hope that it will be useful,

  * but WITHOUT ANY WARRANTY; without even the implied warranty of

- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

- * Lesser General Public License for more details.

- * 

- * You should have received a copy of the GNU Lesser General Public

- * License along with this library; if not, write to the Free Software

- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+ * GNU General Public License for more details.

+ *

+ * You should have received a copy of the GNU General Public License

+ * along with this program; if not, write to the Free Software

+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 

  */

 #include <pjlib-util/md5.h>

 #include <pjlib-util/scanner.h>

diff --git a/pjlib-util/include/pjlib-util/md5.h b/pjlib-util/include/pjlib-util/md5.h
index ce27b6a2..24e504b0 100644
--- a/pjlib-util/include/pjlib-util/md5.h
+++ b/pjlib-util/include/pjlib-util/md5.h
@@ -1,115 +1,55 @@
-/* $Id$

- *

- */

+/* $Id$ */

 /* 

- * PJLIB - PJ Foundation Library

- * (C)2003-2005 Benny Prijono <bennylp@bulukucing.org>

+ * Copyright (C) 2003-2005 Benny Prijono <benny@prijono.org>

  *

- * Author:

- *  Benny Prijono <bennylp@bulukucing.org>

+ * This program is free software; you can redistribute it and/or modify

+ * it under the terms of the GNU General Public License as published by

+ * the Free Software Foundation; either version 2 of the License, or

+ * (at your option) any later version.

  *

- * This library is free software; you can redistribute it and/or

- * modify it under the terms of the GNU Lesser General Public

- * License as published by the Free Software Foundation; either

- * version 2.1 of the License, or (at your option) any later version.

- * 

- * This library is distributed in the hope that it will be useful,

+ * This program is distributed in the hope that it will be useful,

  * but WITHOUT ANY WARRANTY; without even the implied warranty of

- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

- * Lesser General Public License for more details.

- * 

- * You should have received a copy of the GNU Lesser General Public

- * License along with this library; if not, write to the Free Software

- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+ * GNU General Public License for more details.

+ *

+ * You should have received a copy of the GNU General Public License

+ * along with this program; if not, write to the Free Software

+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 

  */

-/*

-  Copyright (C) 1999, 2002 Aladdin Enterprises.  All rights reserved.

-

-  This software is provided 'as-is', without any express or implied

-  warranty.  In no event will the authors be held liable for any damages

-  arising from the use of this software.

+#ifndef __PJLIB_UTIL_MD5_H__

+#define __PJLIB_UTIL_MD5_H__

 

-  Permission is granted to anyone to use this software for any purpose,

-  including commercial applications, and to alter it and redistribute it

-  freely, subject to the following restrictions:

+#include <pj/types.h>

 

-  1. The origin of this software must not be misrepresented; you must not

-     claim that you wrote the original software. If you use this software

-     in a product, an acknowledgment in the product documentation would be

-     appreciated but is not required.

-  2. Altered source versions must be plainly marked as such, and must not be

-     misrepresented as being the original software.

-  3. This notice may not be removed or altered from any source distribution.

+PJ_BEGIN_DECL

 

-  L. Peter Deutsch

-  ghost@aladdin.com

+/** MD5 context. */

+typedef struct pj_md5_context

+{

+	pj_uint32_t buf[4];

+	pj_uint32_t bits[2];

+	pj_uint8_t  in[64];

+} pj_md5_context;

 

+/** Initialize the algorithm. 

+ *  @param pms		MD5 context.

  */

-/* $Id$ */

-/*

-  Independent implementation of MD5 (RFC 1321).

-

-  This code implements the MD5 Algorithm defined in RFC 1321, whose

-  text is available at

-	http://www.ietf.org/rfc/rfc1321.txt

-  The code is derived from the text of the RFC, including the test suite

-  (section A.5) but excluding the rest of Appendix A.  It does not include

-  any code or documentation that is identified in the RFC as being

-  copyrighted.

-

-  The original and principal author of md5.h is L. Peter Deutsch

-  <ghost@aladdin.com>.  Other authors are noted in the change history

-  that follows (in reverse chronological order):

+PJ_DECL(void) pj_md5_init(pj_md5_context *pms);

 

-  2002-04-13 lpd Removed support for non-ANSI compilers; removed

-	references to Ghostscript; clarified derivation from RFC 1321;

-	now handles byte order either statically or dynamically.

-  1999-11-04 lpd Edited comments slightly for automatic TOC extraction.

-  1999-10-18 lpd Fixed typo in header comment (ansi2knr rather than md5);

-	added conditionalization for C++ compilation from Martin

-	Purschke <purschke@bnl.gov>.

-  1999-05-03 lpd Original version.

+/** Append a string to the message. 

+ *  @param pms		MD5 context.

+ *  @param data		Data.

+ *  @param nbytes	Length of data.

  */

+PJ_DECL(void) pj_md5_update( pj_md5_context *pms, 

+			     const pj_uint8_t *data, unsigned nbytes);

 

-#ifndef md5_INCLUDED

-#  define md5_INCLUDED

-

-/*

- * This package supports both compile-time and run-time determination of CPU

- * byte order.  If ARCH_IS_BIG_ENDIAN is defined as 0, the code will be

- * compiled to run only on little-endian CPUs; if ARCH_IS_BIG_ENDIAN is

- * defined as non-zero, the code will be compiled to run only on big-endian

- * CPUs; if ARCH_IS_BIG_ENDIAN is not defined, the code will be compiled to

- * run on either big- or little-endian CPUs, but will run slightly less

- * efficiently on either one than if ARCH_IS_BIG_ENDIAN is defined.

+/** Finish the message and return the digest. 

+ *  @param pms		MD5 context.

+ *  @param digest	16 byte digest.

  */

+PJ_DECL(void) pj_md5_final(pj_md5_context *pms, pj_uint8_t digest[16]);

 

-typedef unsigned char md5_byte_t; /* 8-bit byte */

-typedef unsigned long md5_word_t; /* 32-bit word */

-

-/** Define the state of the MD5 Algorithm. */

-typedef struct md5_state_s {

-    md5_word_t count[2];	/**< message length in bits, lsw first */

-    md5_word_t abcd[4];		/**< digest buffer */

-    md5_byte_t buf[64];		/**< accumulate block */

-} md5_state_t;

-

-#ifdef __cplusplus

-extern "C" 

-{

-#endif

-

-/** Initialize the algorithm. */

-void md5_init(md5_state_t *pms);

-

-/** Append a string to the message. */

-void md5_append(md5_state_t *pms, const md5_byte_t *data, int nbytes);

-

-/** Finish the message and return the digest. */

-void md5_finish(md5_state_t *pms, md5_byte_t digest[16]);

-

-#ifdef __cplusplus

-}  /* end extern "C" */

-#endif

+PJ_END_DECL

 

-#endif /* md5_INCLUDED */

+#endif	/* __PJLIB_UTIL_MD5_H__ */

diff --git a/pjlib-util/include/pjlib-util/scanner.h b/pjlib-util/include/pjlib-util/scanner.h
index a9491431..b2c58c85 100644
--- a/pjlib-util/include/pjlib-util/scanner.h
+++ b/pjlib-util/include/pjlib-util/scanner.h
@@ -1,25 +1,20 @@
-/* $Id$

- */

+/* $Id$ */

 /* 

- * PJLIB - PJ Foundation Library

- * (C)2003-2005 Benny Prijono <bennylp@bulukucing.org>

+ * Copyright (C) 2003-2005 Benny Prijono <benny@prijono.org>

  *

- * Author:

- *  Benny Prijono <bennylp@bulukucing.org>

+ * This program is free software; you can redistribute it and/or modify

+ * it under the terms of the GNU General Public License as published by

+ * the Free Software Foundation; either version 2 of the License, or

+ * (at your option) any later version.

  *

- * This library is free software; you can redistribute it and/or

- * modify it under the terms of the GNU Lesser General Public

- * License as published by the Free Software Foundation; either

- * version 2.1 of the License, or (at your option) any later version.

- * 

- * This library is distributed in the hope that it will be useful,

+ * This program is distributed in the hope that it will be useful,

  * but WITHOUT ANY WARRANTY; without even the implied warranty of

- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

- * Lesser General Public License for more details.

- * 

- * You should have received a copy of the GNU Lesser General Public

- * License along with this library; if not, write to the Free Software

- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+ * GNU General Public License for more details.

+ *

+ * You should have received a copy of the GNU General Public License

+ * along with this program; if not, write to the Free Software

+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 

  */

 #ifndef __PJ_SCANNER_H__

 #define __PJ_SCANNER_H__

diff --git a/pjlib-util/include/pjlib-util/stun.h b/pjlib-util/include/pjlib-util/stun.h
index d2065e70..b2af6d35 100644
--- a/pjlib-util/include/pjlib-util/stun.h
+++ b/pjlib-util/include/pjlib-util/stun.h
@@ -1,23 +1,20 @@
+/* $Id */

 /* 

- * PJLIB - PJ Foundation Library

- * (C)2003-2005 Benny Prijono <bennylp@bulukucing.org>

+ * Copyright (C) 2003-2005 Benny Prijono <benny@prijono.org>

  *

- * Author:

- *  Benny Prijono <bennylp@bulukucing.org>

+ * This program is free software; you can redistribute it and/or modify

+ * it under the terms of the GNU General Public License as published by

+ * the Free Software Foundation; either version 2 of the License, or

+ * (at your option) any later version.

  *

- * This library is free software; you can redistribute it and/or

- * modify it under the terms of the GNU Lesser General Public

- * License as published by the Free Software Foundation; either

- * version 2.1 of the License, or (at your option) any later version.

- * 

- * This library is distributed in the hope that it will be useful,

+ * This program is distributed in the hope that it will be useful,

  * but WITHOUT ANY WARRANTY; without even the implied warranty of

- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

- * Lesser General Public License for more details.

- * 

- * You should have received a copy of the GNU Lesser General Public

- * License along with this library; if not, write to the Free Software

- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+ * GNU General Public License for more details.

+ *

+ * You should have received a copy of the GNU General Public License

+ * along with this program; if not, write to the Free Software

+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 

  */

 #ifndef __PJ_STUN_H__

 #define __PJ_STUN_H__

diff --git a/pjlib-util/include/pjlib-util/xml.h b/pjlib-util/include/pjlib-util/xml.h
index e0ebb4c7..05f67bbf 100644
--- a/pjlib-util/include/pjlib-util/xml.h
+++ b/pjlib-util/include/pjlib-util/xml.h
@@ -1,28 +1,21 @@
-/* $Id$

- *

- */

+/* $Id$ */

 /* 

- * PJLIB - PJ Foundation Library

- * (C)2003-2005 Benny Prijono <bennylp@bulukucing.org>

- *

- * Author:

- *  Benny Prijono <bennylp@bulukucing.org>

- *

- * This library is free software; you can redistribute it and/or

- * modify it under the terms of the GNU Lesser General Public

- * License as published by the Free Software Foundation; either

- * version 2.1 of the License, or (at your option) any later version.

- * 

- * This library is distributed in the hope that it will be useful,

+ * Copyright (C) 2003-2005 Benny Prijono <benny@prijono.org>

+ *

+ * This program is free software; you can redistribute it and/or modify

+ * it under the terms of the GNU General Public License as published by

+ * the Free Software Foundation; either version 2 of the License, or

+ * (at your option) any later version.

+ *

+ * This program is distributed in the hope that it will be useful,

  * but WITHOUT ANY WARRANTY; without even the implied warranty of

- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

- * Lesser General Public License for more details.

- * 

- * You should have received a copy of the GNU Lesser General Public

- * License along with this library; if not, write to the Free Software

- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

+ * GNU General Public License for more details.

+ *

+ * You should have received a copy of the GNU General Public License

+ * along with this program; if not, write to the Free Software

+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 

  */

-

 #ifndef __PJ_XML_H__

 #define __PJ_XML_H__