Skip to content

Commit 8640121

Browse files
author
Dimitri van Heesch
committed
Merge pull request doxygen#450 from jwilk/spelling
Fix documentation typos
2 parents 48e6c49 + 770adb3 commit 8640121

File tree

6 files changed

+55
-56
lines changed

6 files changed

+55
-56
lines changed

doc/changelog.doc

Lines changed: 40 additions & 41 deletions
Large diffs are not rendered by default.

doc/commands.doc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3319,7 +3319,7 @@ class Receiver
33193319

33203320
\addindex \\\---
33213321
This command writes three dashes (\---) to the output. This allows
3322-
writing three consecutuve dashes to the output instead of one m-dash character (---).
3322+
writing three consecutive dashes to the output instead of one m-dash character (---).
33233323

33243324
<hr>
33253325
\htmlonly</p><center><p>\endhtmlonly

doc/docblocks.doc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@ using structural commands:
429429
\endverbatim
430430

431431
Make sure that the script is explicitly listed in the \ref cfg_input "INPUT" or
432-
that \ref cfg_file_patterns "FILE_PATTERNS" includes the `.sh` extention and the
432+
that \ref cfg_file_patterns "FILE_PATTERNS" includes the `.sh` extension and the
433433
the script can be found in the path set via \ref cfg_example_path "EXAMPLE_PATH".
434434

435435
\subsection pythonblocks Comment blocks in Python

doc/extsearch.doc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ You should now get the following message:
116116

117117
Test successful.
118118

119-
Now you should be enable to search for words and symbols from the HTML output.
119+
Now you should be able to search for words and symbols from the HTML output.
120120

121121
\subsection extsearch_multi Multi project index
122122

doc/maintainers.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
% The following one or more lines contain information about
66
% the maintainer(s) for the language (one line, one maintainer)
77
% in the form: <readable name><colon><e-mail>
8-
% If the readable name name starts with '--' it will be displayed in HTML
9-
% output as a highlighted text notice related to the langluage (usually
8+
% If the readable name starts with '--' it will be displayed in HTML
9+
% output as a highlighted text notice related to the language (usually
1010
% '-- searching for the maintainer --').
1111
% If the <e-mail> is prefixed [some_text] it is not displayed in the table
1212
% of maintainers in the Doxygen documentation, nor it is used when building

doc/translator.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@
5454
2010/03/03 - Added [unreachable] prefix used in maintainers.txt.
5555
2010/05/28 - BOM skipped; minor code cleaning.
5656
2010/05/31 - e-mail mangled already in maintainers.txt
57-
2010/08/20 - maintainers.txt to UTF-8, related processin of unicode strings
57+
2010/08/20 - maintainers.txt to UTF-8, related processing of unicode strings
5858
- [any mark] introduced instead of [unreachable] only
59-
- marks hihglighted in HTML
59+
- marks highlighted in HTML
6060
2010/08/30 - Highlighting in what will be the table in langhowto.html modified.
6161
2010/09/27 - The underscore in \latexonly part of the generated language.doc
6262
was prefixed by backslash (was LaTeX related error).
@@ -91,7 +91,7 @@ def xopen(fname, mode='r', encoding='utf-8-sig'):
9191

9292

9393
def fill(s):
94-
"""Returns string formated to the wrapped paragraph multiline string.
94+
"""Returns string formatted to the wrapped paragraph multiline string.
9595
9696
Replaces whitespaces by one space and then uses he textwrap.fill()."""
9797

@@ -159,7 +159,7 @@ def __tokenGenerator(self):
159159
160160
The tokens have the form (tokenId, tokenString, lineNo). The
161161
last returned token has the form ('eof', None, None). When trying
162-
to access next token afer that, the exception would be raised."""
162+
to access next token after that, the exception would be raised."""
163163

164164
# Set the dictionary for recognizing tokenId for keywords, separators
165165
# and the similar categories. The key is the string to be recognized,
@@ -727,7 +727,7 @@ def __collectPublicMethodPrototypes(self, tokenIterator):
727727
The dictionary is filled by items: uniPrototype -> prototype.
728728
The method is expected to be called only for TranslatorXxxx classes,
729729
i.e. for the classes that implement translation to some language.
730-
It assumes that the openning curly brace of the class was already
730+
It assumes that the opening curly brace of the class was already
731731
consumed. The source is consumed until the end of the class.
732732
The caller should consume the source until the eof to cause closing
733733
the source file."""
@@ -738,7 +738,7 @@ def __collectPublicMethodPrototypes(self, tokenIterator):
738738
# The following finite automaton slightly differs from the one
739739
# inside self.collectPureVirtualPrototypes(). It produces the
740740
# dictionary item just after consuming the body of the method
741-
# (transition from from state 10 to state 2). It also does not allow
741+
# (transition from state 10 to state 2). It also does not allow
742742
# definitions of public pure virtual methods, except for
743743
# TranslatorAdapterBase (states 8 and 9). Argument identifier inside
744744
# method argument lists can be omitted or commented.
@@ -1234,7 +1234,7 @@ def __init__(self):
12341234
self.doc_path = os.path.join(self.doxy_path, 'doc')
12351235
self.src_path = os.path.join(self.doxy_path, 'src')
12361236

1237-
# Create the empty dictionary for Transl object identitied by the
1237+
# Create the empty dictionary for Transl object identified by the
12381238
# class identifier of the translator.
12391239
self.__translDic = {}
12401240

@@ -1484,7 +1484,7 @@ def __checkForNotUsedTrMethods(self):
14841484
def __emails(self, classId):
14851485
"""Returns the list of maintainer emails.
14861486
1487-
The method returns the list of e-mail adresses for the translator
1487+
The method returns the list of e-mail addresses for the translator
14881488
class, but only the addresses that were not marked as [xxx]."""
14891489
lst = []
14901490
for m in self.__maintainersDic[classId]:
@@ -1847,7 +1847,7 @@ def generateLanguageDoc(self):
18471847
for name, obj in self.langLst:
18481848
# Fill the table data elements for one row. The first element
18491849
# contains the readable name of the language. Only the oldest
1850-
# translator are colour marked in the language columnt. Less
1850+
# translator are colour marked in the language column. Less
18511851
# "heavy" color is used (when compared with the Status column).
18521852
if obj.readableStatus.startswith('1.4'):
18531853
bkcolor = self.getBgcolorByReadableStatus('1.4')
@@ -1882,7 +1882,7 @@ def generateLanguageDoc(self):
18821882
lm.append(name)
18831883
mm = '<br/>'.join(lm)
18841884

1885-
# The marked adresses (they start with the mark '[unreachable]',
1885+
# The marked addresses (they start with the mark '[unreachable]',
18861886
# '[resigned]', whatever '[xxx]') will not be displayed at all.
18871887
# Only the mark will be used instead.
18881888
rexMark = re.compile('(?P<mark>\\[.*?\\])')

0 commit comments

Comments
 (0)