Permalink
Browse files

Fix documentation typos

  • Loading branch information...
jwilk committed Feb 2, 2016
1 parent 3785228 commit 770adb37b2072bbea5412f9cc2058d98d1de60e4
Showing with 55 additions and 56 deletions.
  1. +40 −41 doc/changelog.doc
  2. +1 −1 doc/commands.doc
  3. +1 −1 doc/docblocks.doc
  4. +1 −1 doc/extsearch.doc
  5. +2 −2 doc/maintainers.txt
  6. +10 −10 doc/translator.py
View

Large diffs are not rendered by default.

Oops, something went wrong.
View
@@ -3319,7 +3319,7 @@ class Receiver
\addindex \\\---
This command writes three dashes (\---) to the output. This allows
writing three consecutuve dashes to the output instead of one m-dash character (---).
writing three consecutive dashes to the output instead of one m-dash character (---).
<hr>
\htmlonly</p><center><p>\endhtmlonly
View
@@ -429,7 +429,7 @@ using structural commands:
\endverbatim
Make sure that the script is explicitly listed in the \ref cfg_input "INPUT" or
that \ref cfg_file_patterns "FILE_PATTERNS" includes the `.sh` extention and the
that \ref cfg_file_patterns "FILE_PATTERNS" includes the `.sh` extension and the
the script can be found in the path set via \ref cfg_example_path "EXAMPLE_PATH".
\subsection pythonblocks Comment blocks in Python
View
@@ -116,7 +116,7 @@ You should now get the following message:
Test successful.
Now you should be enable to search for words and symbols from the HTML output.
Now you should be able to search for words and symbols from the HTML output.
\subsection extsearch_multi Multi project index
View
@@ -5,8 +5,8 @@
% The following one or more lines contain information about
% the maintainer(s) for the language (one line, one maintainer)
% in the form: <readable name><colon><e-mail>
% If the readable name name starts with '--' it will be displayed in HTML
% output as a highlighted text notice related to the langluage (usually
% If the readable name starts with '--' it will be displayed in HTML
% output as a highlighted text notice related to the language (usually
% '-- searching for the maintainer --').
% If the <e-mail> is prefixed [some_text] it is not displayed in the table
% of maintainers in the Doxygen documentation, nor it is used when building
View
@@ -54,9 +54,9 @@
2010/03/03 - Added [unreachable] prefix used in maintainers.txt.
2010/05/28 - BOM skipped; minor code cleaning.
2010/05/31 - e-mail mangled already in maintainers.txt
2010/08/20 - maintainers.txt to UTF-8, related processin of unicode strings
2010/08/20 - maintainers.txt to UTF-8, related processing of unicode strings
- [any mark] introduced instead of [unreachable] only
- marks hihglighted in HTML
- marks highlighted in HTML
2010/08/30 - Highlighting in what will be the table in langhowto.html modified.
2010/09/27 - The underscore in \latexonly part of the generated language.doc
was prefixed by backslash (was LaTeX related error).
@@ -91,7 +91,7 @@ def xopen(fname, mode='r', encoding='utf-8-sig'):
def fill(s):
"""Returns string formated to the wrapped paragraph multiline string.
"""Returns string formatted to the wrapped paragraph multiline string.
Replaces whitespaces by one space and then uses he textwrap.fill()."""
@@ -159,7 +159,7 @@ def __tokenGenerator(self):
The tokens have the form (tokenId, tokenString, lineNo). The
last returned token has the form ('eof', None, None). When trying
to access next token afer that, the exception would be raised."""
to access next token after that, the exception would be raised."""
# Set the dictionary for recognizing tokenId for keywords, separators
# and the similar categories. The key is the string to be recognized,
@@ -727,7 +727,7 @@ def __collectPublicMethodPrototypes(self, tokenIterator):
The dictionary is filled by items: uniPrototype -> prototype.
The method is expected to be called only for TranslatorXxxx classes,
i.e. for the classes that implement translation to some language.
It assumes that the openning curly brace of the class was already
It assumes that the opening curly brace of the class was already
consumed. The source is consumed until the end of the class.
The caller should consume the source until the eof to cause closing
the source file."""
@@ -738,7 +738,7 @@ def __collectPublicMethodPrototypes(self, tokenIterator):
# The following finite automaton slightly differs from the one
# inside self.collectPureVirtualPrototypes(). It produces the
# dictionary item just after consuming the body of the method
# (transition from from state 10 to state 2). It also does not allow
# (transition from state 10 to state 2). It also does not allow
# definitions of public pure virtual methods, except for
# TranslatorAdapterBase (states 8 and 9). Argument identifier inside
# method argument lists can be omitted or commented.
@@ -1234,7 +1234,7 @@ def __init__(self):
self.doc_path = os.path.join(self.doxy_path, 'doc')
self.src_path = os.path.join(self.doxy_path, 'src')
# Create the empty dictionary for Transl object identitied by the
# Create the empty dictionary for Transl object identified by the
# class identifier of the translator.
self.__translDic = {}
@@ -1484,7 +1484,7 @@ def __checkForNotUsedTrMethods(self):
def __emails(self, classId):
"""Returns the list of maintainer emails.
The method returns the list of e-mail adresses for the translator
The method returns the list of e-mail addresses for the translator
class, but only the addresses that were not marked as [xxx]."""
lst = []
for m in self.__maintainersDic[classId]:
@@ -1847,7 +1847,7 @@ def generateLanguageDoc(self):
for name, obj in self.langLst:
# Fill the table data elements for one row. The first element
# contains the readable name of the language. Only the oldest
# translator are colour marked in the language columnt. Less
# translator are colour marked in the language column. Less
# "heavy" color is used (when compared with the Status column).
if obj.readableStatus.startswith('1.4'):
bkcolor = self.getBgcolorByReadableStatus('1.4')
@@ -1882,7 +1882,7 @@ def generateLanguageDoc(self):
lm.append(name)
mm = '<br/>'.join(lm)
# The marked adresses (they start with the mark '[unreachable]',
# The marked addresses (they start with the mark '[unreachable]',
# '[resigned]', whatever '[xxx]') will not be displayed at all.
# Only the mark will be used instead.
rexMark = re.compile('(?P<mark>\\[.*?\\])')

0 comments on commit 770adb3

Please sign in to comment.