Skip to content

Commit 3658275

Browse files
committed
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.
1 parent d6c974b commit 3658275

File tree

2 files changed

+45
-20
lines changed

2 files changed

+45
-20
lines changed

include/tidybuffio.h

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,25 @@
11
#ifndef __TIDY_BUFFIO_H__
22
#define __TIDY_BUFFIO_H__
33

4-
/** @file tidybuffio.h - Treat buffer as an I/O stream.
5-
6-
(c) 1998-2016 (W3C) MIT, ERCIM, Keio University
7-
See tidy.h for the copyright notice.
8-
9-
Requires buffer to automatically grow as bytes are added.
10-
Must keep track of current read and write points.
11-
12-
*/
4+
/**************************************************************************//**
5+
* @file
6+
* Treat buffer as a stream that Tidy can use for I/O operations. It offers
7+
* the ability for the buffer to grow as bytes are added, and keeps track
8+
* of current read and write points.
9+
*
10+
* @author
11+
* HTACG, et al (consult git log)
12+
*
13+
* @copyright
14+
* Copyright (c) 1998-2017 World Wide Web Consortium (Massachusetts
15+
* Institute of Technology, European Research Consortium for Informatics
16+
* and Mathematics, Keio University).
17+
* @copyright
18+
* See tidy.h for license.
19+
*
20+
* @date
21+
* Consult git log.
22+
******************************************************************************/
1323

1424
#include "tidyplatform.h"
1525
#include "tidy.h"

include/tidyplatform.h

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,32 @@
11
#ifndef __TIDY_PLATFORM_H__
22
#define __TIDY_PLATFORM_H__
33

4-
/** @file tidyplatform.h - Platform specifics
5-
6-
(c) 1998-2016 (W3C) MIT, ERCIM, Keio University
7-
See tidy.h for the copyright notice.
8-
9-
This file is included by tidy.h, and need not
10-
be included sepearately. It sets a number of
11-
default defines, and a PLATFORM_NAME, and includes
12-
the most common system headers.
13-
14-
*/
4+
/**************************************************************************//**
5+
* @file
6+
* Platform specific definitions, specifics, and headers. This file is
7+
* included by `tidy.h` already, and need not be included separately. Among
8+
* other things, the PLATFORM_NAME is defined and the most common systems
9+
* headers are included.
10+
*
11+
* @note It should be largely unnecessary to modify this file unless adding
12+
* support for a completely new architecture. Most options defined in this
13+
* file specify defaults that can be overriden by the build system; for
14+
* example, passing -D flags to CMake.
15+
*
16+
* @author Charles Reitzel [creitzel@rcn.com]
17+
* @author HTACG, et al (consult git log)
18+
*
19+
* @copyright
20+
* Copyright (c) 1998-2017 World Wide Web Consortium (Massachusetts
21+
* Institute of Technology, European Research Consortium for Informatics
22+
* and Mathematics, Keio University).
23+
* @copyright
24+
* See tidy.h for license.
25+
*
26+
* @date Created 2001-05-20 by Charles Reitzel
27+
* @date Updated 2002-07-01 by Charles Reitzel
28+
* @date Further modifications: consult git log.
29+
******************************************************************************/
1530

1631
#ifdef __cplusplus
1732
extern "C" {

0 commit comments

Comments
 (0)