tidy-html5/CODESTYLE.md

# HTML Tidy Code Style

The source code of **libTidy**, and console Tidy, follow the preferences of the original maintainers. Perhaps some of these decisions were arbitrary and based on their sense of aesthetics but it is good to have all the code look the same even if it is not exactly how everyone would prefer.

Developers adding code to Tidy! are urged to try to follow the existing code style. Code that does not follow these conventions will be accepted, but will be modified as time goes by to best fit the `Tidy Style`.

There has been a suggestion of using available utilities to make the style consistent, like [Uncrusty](https://github/bengardener/uncrusty)...

Others have suggested the [AStyle](http://astyle.sourceforge.net/) formatting program with say  '-taOHUKk3 -M8' arguments, to conform, but there are a few bugs in AStyle.

But again these, and other tools, may not produce code that everybody agrees with... and are presently not formally used in Tidy!

#### Known Conventions

From reading of the Tidy source, some things are self evident... in no particular order...

 - Use of 4-space indenting, and no tabs.
 - No C++ single line comments using `//`.
 - The openning `{` is indented on the next newline.
 - While the maximum code line length varies, generally long `if`, `while`, ... statements are wrapped to newlines.

Look forward to this document being filled out in detail...

Date: 20150904

; eof
Begin some notes on Tidy code style 2015-09-04 13:47:46 +00:00			`# HTML Tidy Code Style`

correct speliling in CODESTYLE.md 2015-09-04 13:52:12 +00:00			`The source code of libTidy, and console Tidy, follow the preferences of the original maintainers. Perhaps some of these decisions were arbitrary and based on their sense of aesthetics but it is good to have all the code look the same even if it is not exactly how everyone would prefer.`
Begin some notes on Tidy code style 2015-09-04 13:47:46 +00:00
			Developers adding code to Tidy! are urged to try to follow the existing code style. Code that does not follow these conventions will be accepted, but will be modified as time goes by to best fit the `Tidy Style`.

			`There has been a suggestion of using available utilities to make the style consistent, like [Uncrusty](https://github/bengardener/uncrusty)...`

correct speliling in CODESTYLE.md 2015-09-04 13:52:12 +00:00			`Others have suggested the [AStyle](http://astyle.sourceforge.net/) formatting program with say '-taOHUKk3 -M8' arguments, to conform, but there are a few bugs in AStyle.`
Begin some notes on Tidy code style 2015-09-04 13:47:46 +00:00
correct speliling in CODESTYLE.md 2015-09-04 13:52:12 +00:00			`But again these, and other tools, may not produce code that everybody agrees with... and are presently not formally used in Tidy!`
Begin some notes on Tidy code style 2015-09-04 13:47:46 +00:00
			`#### Known Conventions`

			`From reading of the Tidy source, some things are self evident... in no particular order...`

			`- Use of 4-space indenting, and no tabs.`
			- No C++ single line comments using `//`.
			- The openning `{` is indented on the next newline.
			- While the maximum code line length varies, generally long `if`, `while`, ... statements are wrapped to newlines.

			`Look forward to this document being filled out in detail...`

			`Date: 20150904`

			`; eof`