From 3658275f60f533ebebd18ec719a807876d99f22f Mon Sep 17 00:00:00 2001 From: Jim Derry Date: Sat, 30 Sep 2017 09:35:00 -0400 Subject: [PATCH] Documentation-only changes to the public headers for consistency with other headers (part of long term internal documentation project). No version bump as no binary image change. --- include/tidybuffio.h | 28 +++++++++++++++++++--------- include/tidyplatform.h | 37 ++++++++++++++++++++++++++----------- 2 files changed, 45 insertions(+), 20 deletions(-) diff --git a/include/tidybuffio.h b/include/tidybuffio.h index 7410da7..1c1b017 100644 --- a/include/tidybuffio.h +++ b/include/tidybuffio.h @@ -1,15 +1,25 @@ #ifndef __TIDY_BUFFIO_H__ #define __TIDY_BUFFIO_H__ -/** @file tidybuffio.h - Treat buffer as an I/O stream. - - (c) 1998-2016 (W3C) MIT, ERCIM, Keio University - See tidy.h for the copyright notice. - - Requires buffer to automatically grow as bytes are added. - Must keep track of current read and write points. - -*/ +/**************************************************************************//** + * @file + * Treat buffer as a stream that Tidy can use for I/O operations. It offers + * the ability for the buffer to grow as bytes are added, and keeps track + * of current read and write points. + * + * @author + * HTACG, et al (consult git log) + * + * @copyright + * Copyright (c) 1998-2017 World Wide Web Consortium (Massachusetts + * Institute of Technology, European Research Consortium for Informatics + * and Mathematics, Keio University). + * @copyright + * See tidy.h for license. + * + * @date + * Consult git log. + ******************************************************************************/ #include "tidyplatform.h" #include "tidy.h" diff --git a/include/tidyplatform.h b/include/tidyplatform.h index 9187e4b..597bb04 100644 --- a/include/tidyplatform.h +++ b/include/tidyplatform.h @@ -1,17 +1,32 @@ #ifndef __TIDY_PLATFORM_H__ #define __TIDY_PLATFORM_H__ -/** @file tidyplatform.h - Platform specifics - - (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. - -*/ +/**************************************************************************//** + * @file + * Platform specific definitions, specifics, and headers. This file is + * included by `tidy.h` already, and need not be included separately. Among + * other things, the PLATFORM_NAME is defined and the most common systems + * headers are included. + * + * @note It should be largely unnecessary to modify this file unless adding + * support for a completely new architecture. Most options defined in this + * file specify defaults that can be overriden by the build system; for + * example, passing -D flags to CMake. + * + * @author Charles Reitzel [creitzel@rcn.com] + * @author HTACG, et al (consult git log) + * + * @copyright + * Copyright (c) 1998-2017 World Wide Web Consortium (Massachusetts + * Institute of Technology, European Research Consortium for Informatics + * and Mathematics, Keio University). + * @copyright + * See tidy.h for license. + * + * @date Created 2001-05-20 by Charles Reitzel + * @date Updated 2002-07-01 by Charles Reitzel + * @date Further modifications: consult git log. + ******************************************************************************/ #ifdef __cplusplus extern "C" {