Improve doxy comment formating - no code changes

Author: geoffmcl

include/buffio.h

@@ -1,6 +1,17 @@
+/** @file buffio.h - Deprecated compatibility header. Use tidybuffio.h
+**
+** @deprecated This compatibility header is deprecated and 
+** should be replaced by tidybuffio.h. This header will be removed!
+**
+*/
+
 #ifdef __GNUC__
-#warning "FIXME: Using compatibility tidy header (buffio.h) that will go away!"
+#warning "FIXME: Using compatibility tidy header (buffio.h) that will go away! Use tidybuffio.h"
+#endif
+#ifdef _MSC_VER
+#pragma message("WARNING: ** FIXME ** Using compatibility tidy header (buffio.h) that will go away! Use tidybuffio.h")
 #endif
 
 #include "tidybuffio.h"
 
+

include/platform.h

@@ -1,6 +1,15 @@
+/** @file platform.h - Deprecated compatibility header. Use tidyplatform.h
+**
+** @deprecated This compatibility header is deprecated and 
+** should be replaced by tidyplatform.h. This header will be removed!
+**
+*/
 #ifdef __GNUC__
 #warning "FIXME: Using compatibility tidy header (platform.h) that will go away!"
 #endif
+#ifdef _MSC_VER
+#pragma message("WARNING: ** FIXME ** Using compatibility tidy header (platform.h) that will go away! Use tidyplatform.h")
+#endif
 
 #include "tidyplatform.h"
 

include/tidy.h

@@ -11,7 +11,7 @@
   this-equivalent as 1st arg.
 
 
-  Copyright (c) 1998-2008 World Wide Web Consortium
+  Copyright (c) 1998-2016 World Wide Web Consortium
   (Massachusetts Institute of Technology, European Research 
   Consortium for Informatics and Mathematics, Keio University).
   All Rights Reserved.
@@ -476,7 +476,7 @@ TIDY_EXPORT TidyIterator TIDY_CALL  tidyOptGetPickList( TidyOption opt );
 /** Get next string value of Option "pick list" */
 TIDY_EXPORT ctmbstr TIDY_CALL       tidyOptGetNextPick( TidyOption opt, TidyIterator* pos );
 
-/** Get current Option value as a string */
+/** Get string Option current value. Note, the optID "must" be a type 'TidyString'! */
 TIDY_EXPORT ctmbstr TIDY_CALL       tidyOptGetValue( TidyDoc tdoc, TidyOptionId optId );
 /** Set Option value as a string */
 TIDY_EXPORT Bool TIDY_CALL          tidyOptSetValue( TidyDoc tdoc, TidyOptionId optId, ctmbstr val );

include/tidybuffio.h

@@ -3,7 +3,7 @@
 
 /** @file tidybuffio.h - Treat buffer as an I/O stream.
 
-  (c) 1998-2007 (W3C) MIT, ERCIM, Keio University
+  (c) 1998-2016 (W3C) MIT, ERCIM, Keio University
   See tidy.h for the copyright notice.
 
   Requires buffer to automatically grow as bytes are added.

include/tidyenum.h

@@ -1,55 +1,13 @@
 #ifndef __TIDYENUM_H__
 #define __TIDYENUM_H__
 
-/* @file tidyenum.h -- Split public enums into separate header
+/** @file tidyenum.h - Separated public enumerations header
 
   Simplifies enum re-use in various wrappers.  e.g. SWIG
   generated wrappers and COM IDL files.
 
-  Copyright (c) 1998-2008 World Wide Web Consortium
-  (Massachusetts Institute of Technology, European Research
-  Consortium for Informatics and Mathematics, Keio University).
-  All Rights Reserved.
-
-  Contributing Author(s):
-
-     Dave Raggett <[email protected]>
-
-  The contributing author(s) would like to thank all those who
-  helped with testing, bug fixes and suggestions for improvements.
-  This wouldn't have been possible without your help.
-
-  COPYRIGHT NOTICE:
-
-  This software and documentation is provided "as is," and
-  the copyright holders and contributing author(s) make no
-  representations or warranties, express or implied, including
-  but not limited to, warranties of merchantability or fitness
-  for any particular purpose or that the use of the software or
-  documentation will not infringe any third party patents,
-  copyrights, trademarks or other rights.
-
-  The copyright holders and contributing author(s) will not be held
-  liable for any direct, indirect, special or consequential damages
-  arising out of any use of the software or documentation, even if
-  advised of the possibility of such damage.
-
-  Permission is hereby granted to use, copy, modify, and distribute
-  this source code, or portions hereof, documentation and executables,
-  for any purpose, without fee, subject to the following restrictions:
-
-  1. The origin of this source code must not be misrepresented.
-  2. Altered versions must be plainly marked as such and must
-     not be misrepresented as being the original source.
-  3. This Copyright notice may not be removed or altered from any
-     source or altered source distribution.
-
-  The copyright holders and contributing author(s) specifically
-  permit, without fee, and encourage the use of this source code
-  as a component for supporting the Hypertext Markup Language in
-  commercial products. If you use this source code in a product,
-  acknowledgment is not required but would be appreciated.
-
+  (c) 1998-2016 (W3C) MIT, ERCIM, Keio University
+  See tidy.h for the full copyright notice.
 
   Created 2001-05-20 by Charles Reitzel
   Updated 2002-07-01 by Charles Reitzel - 1st Implementation

include/tidyplatform.h

@@ -1,10 +1,15 @@
 #ifndef __TIDY_PLATFORM_H__
 #define __TIDY_PLATFORM_H__
 
-/* tidyplatform.h -- Platform specifics
+/** @file tidyplatform.h - Platform specifics
 
-  (c) 1998-2008 (W3C) MIT, ERCIM, Keio University
+  (c) 1998-2016 (W3C) MIT, ERCIM, Keio University
   See tidy.h for the copyright notice.
+  
+  This file is included by tidy.h, and need not 
+  be included sepearately. It sets a number of 
+  default defines, and a PLATFORM_NAME, and includes
+  the most common system headers.
 
 */