Skip to content

Commit 1bb72d6

Browse files
committed
Spelling fixes, thanks to @jschleus.
1 parent e03fee5 commit 1bb72d6

37 files changed

+72
-72
lines changed

README/CODESTYLE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ From reading of the Tidy source, some things are self evident, in no particular
1616

1717
- Use of 4-space indenting, and no tabs.
1818
- No C++ single line comments using `//`.
19-
- The openning `{` is indented on the next newline.
19+
- The opening `{` is indented on the next newline.
2020
- While the maximum code line length varies, generally long `if`, `while`, ... statements are wrapped to newlines.
2121
- Pointer operators in declarations must precede any macro documentation, e.g, `const tidyLocaleMapItem* TIDY_CALL getNextWindowsLanguage( TidyIterator* iter )` instead of `const tidyLocaleMapItem TIDY_CALL *getNextWindowsLanguage( TidyIterator* iter )` in case `TIDY_CALL` is defined.
2222

README/MESSAGES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,6 @@ Note that Tidy doesn't currently support numbered `printf` parameters; parameter
3636

3737
The last step — hopefully — is adding the message key to the `dispatchTable[]` structure in `message.c`. This structure determines the `TidyReportLevel` (report severity) and message formatter (how to print the message). Then whenever you issue the report with `TY_(Report)()` or one of the existing convenience report functions, the correct message formatter will be used for the parameters that you specify.
3838

39-
Please read the source code in `message.c` for help on how to choose a message formatter, or how to modify one of the existing message formatters if you need to accomodate a new function signature for your report.
39+
Please read the source code in `message.c` for help on how to choose a message formatter, or how to modify one of the existing message formatters if you need to accommodate a new function signature for your report.
4040

4141
eof;

README/OPTIONS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Tidy supports a quite large number of configuration options. The full list can be output using `-help-config`. This will show the option to be used either on the command line or in a configuration file, the type of option, and the value(s) that can be used. The current default value for each option can be seen using `-show-config`.
44

5-
The options can also be listed in xml format. `-xml-help` will output each option plus a description. `-xml-config` will not only output the option and a desciption, but will include the type, default and examples. These xml outputs are used, with the aid of `xsltproc` and `doxygen`, to generate the [API Documentation](http://api.html-tidy.org/).
5+
The options can also be listed in xml format. `-xml-help` will output each option plus a description. `-xml-config` will not only output the option and a description, but will include the type, default and examples. These xml outputs are used, with the aid of `xsltproc` and `doxygen`, to generate the [API Documentation](http://api.html-tidy.org/).
66

77
These options can also be used by application linking with `libtidy`. For each option there is a `TidyOptionId` enumeration in the `tidyenum.h` file, and get/set functions for each option type.
88

@@ -17,7 +17,7 @@ This file indicates how to add a new option to tidy, here adding an option `Tidy
1717

1818
In `tidyenum.h` the `TidyOptionId` can be in any order, but please try to keep things alphabetical, and keep in mind that `N_TIDY_OPTIONS` must remain the last. Choosing the id name can be any string, but by convention it will commence with `Tidy` followed by brief descriptive text.
1919

20-
Naturally it can not be the same as any exisitng option. That is, it must be unique. And it will be followed by a brief descriptive special doxygen formatted comment. So for this new option I have chosen -
20+
Naturally it can not be the same as any existing option. That is, it must be unique. And it will be followed by a brief descriptive special doxygen formatted comment. So for this new option I have chosen -
2121

2222
~~~
2323
TidyEscapeScripts, /**< Escape items that look like closing tags */
@@ -105,7 +105,7 @@ The `key` is the option `ID`; The `pluralForm` is not used for options, and shou
105105

106106
Some care has to be taken with the description string. The only html allowed here is `<code>...</code>`, `<var>...</var>`, `<em>...</em>`, `<strong>...</strong>`, and `<br/>`. Entities, tags, attributes, etc., should be enclosed in `<code>...</code>`. Option values should be enclosed in `<var>...</var>`. It's very important that `<br/>` be self-closing! This string is processed to build the API documentation.
107107

108-
This is the desription added for this new option.
108+
This is the description added for this new option.
109109

110110
~~~
111111
{

README/README.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ <h2 id="prerequisites">Prerequisites</h2>
1111

1212
<p>CMake comes in two forms - command line and GUI. Some installations only install one or the other, but sometimes both. The build commands below are only for command line use.</p>
1313

14-
<p>Also the actual build tools vary for each platform. But that is one of the great features of CMake, it can generate variuous &#8216;native&#8217; build files. Running <code>cmake --help</code> should list the generators available on that platform. For sure one of the common ones is &#8220;Unix Makefiles&#8221;, which needs autotools make installed, but many other generators are supported.</p>
14+
<p>Also the actual build tools vary for each platform. But that is one of the great features of CMake, it can generate various &#8216;native&#8217; build files. Running <code>cmake --help</code> should list the generators available on that platform. For sure one of the common ones is &#8220;Unix Makefiles&#8221;, which needs autotools make installed, but many other generators are supported.</p>
1515

1616
<p>In Windows CMake offers various versions for MSVC. Again below only the command line use of MSVC is shown, but the tidy solution (*.sln) file can be loaded into the MSVC IDE, and the building done in there.</p>
1717

README/TAGS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This is about adding a new HTML **tag**.
44

5-
Tidy tries to support all **tags** supported by the W3C. To add a new supported **tag**, the defintion begins in `tidyenum.h`, to give it a value. Then it is added to the `tag_defs[]` table in `tags.c`, where it is given a unique string, supported html versions, attributes support, and a bit `type`.
5+
Tidy tries to support all **tags** supported by the W3C. To add a new supported **tag**, the definition begins in `tidyenum.h`, to give it a value. Then it is added to the `tag_defs[]` table in `tags.c`, where it is given a unique string, supported html versions, attributes support, and a bit `type`.
66

77
Note, there are a group of configuration options to add **tags** not yet approved by the W3C. These are [new-blocklevel-tags](http://api.html-tidy.org/tidy/quickref_5.2.0.html#new-blocklevel-tags), [new-empty-tags](http://api.html-tidy.org/tidy/quickref_5.2.0.html#new-empty-tags), [new-inline-tags](http://api.html-tidy.org/tidy/quickref_5.2.0.html#new-inline-tags). and [new-pre-tags](http://api.html-tidy.org/tidy/quickref_5.2.0.html#new-pre-tags). This provides a way to extend the `tag_defs[]` table just for that tidy session.
88

README/TESTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ write at least one test case in `github-cases` and put the expected results in
3737
importantly, will become part of the standard regression testing suite once the
3838
PR is merged.
3939

40-
Try to keep your test case(s) as succint as possible, and do try to put some HTML
40+
Try to keep your test case(s) as succinct as possible, and do try to put some HTML
4141
comments in the file explaining the purpose of the test case, and if applicable,
4242
the Github issue and/or PR number.
4343

@@ -69,4 +69,4 @@ determined that a standards change #yyyy impacts us because of zzz.
6969

7070
## Regression Testing Specifics
7171

72-
The regression testing mechanism is described more fully in [regression_testing/README.md](../regression_testing/README.md).
72+
The regression testing mechanism is described more fully in [regression_testing/README.md](../regression_testing/README.md).

README/VERSION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ add_definitions ( -DLIBTIDY_VERSION="${LIBTIDY_VERSION}" )
7070
add_definitions ( -DRELEASE_DATE="${tidy_YEAR}/${tidy_MONTH}/${tidy_DAY}" )
7171
~~~
7272

73-
And in `CMakeLists.txt` there is the posibility to define another macro, when and if required:
73+
And in `CMakeLists.txt` there is the possibility to define another macro, when and if required:
7474

7575
~~~
7676
# add_definitions ( -DRC_NUMBER="D231" )

build/cmake/build-api.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ TMPZFIL="../../documentation/$TMPZIP"
3737
if [ -f "$TMPZFIL" ]; then
3838
ls -l $TMPZFIL
3939
echo "$BN: WARNING: Current ZIP will be overwritten!"
40-
echo "$BN: DO you want to coninue?"
40+
echo "$BN: DO you want to continue?"
4141
ask
4242
fi
4343

@@ -49,7 +49,7 @@ if [ ! -x "$TMPFIL" ]; then
4949
fi
5050

5151
if [ -d "$TMPDIR" ]; then
52-
echo "$BN: Directory '$TMPDIR' will be deleted prior the documentaion build..."
52+
echo "$BN: Directory '$TMPDIR' will be deleted prior the documentation build..."
5353
fi
5454

5555
./$TMPFIL -DBUILD_DOCUMENTATION:BOOL=YES

build/cmake/build-me.bat

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
@if "%TMPINDBG%x" == "1x" (
6767
@echo Will install Debug and Release
6868
) else {
69-
@echo Will only intall Release
69+
@echo Will only install Release
7070
)
7171
@echo.
7272

build/win64/build-me.bat

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767
@if "%TMPINDBG%x" == "1x" (
6868
@echo Will install Debug and Release
6969
) else (
70-
@echo Will only intall Release
70+
@echo Will only install Release
7171
)
7272
@echo.
7373

0 commit comments

Comments
 (0)