[gtk-doc: 1/2] Fix typos
- From: Stefan Sauer <stefkost src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk-doc: 1/2] Fix typos
- Date: Wed, 3 Oct 2018 08:17:44 +0000 (UTC)
commit d29867dc0b47a82c2e4875824e3130fbee75885f
Author: Rafael Fontenelle <rffontenelle gmail com>
Date: Wed Oct 3 08:17:32 2018 +0000
Fix typos
ChangeLog | 50 +++++++++++++++++++-------------------
NEWS | 6 ++---
TODO | 17 ++++++-------
devhelp2.xsd | 6 ++---
doc/design-2.x.txt | 6 ++---
doc/gtkdoc.dot | 2 +-
examples/Makefile.am | 2 +-
gtk-doc.xsl | 6 ++---
gtkdoc/fixxref.py | 4 +--
gtkdoc/mkdb.py | 28 ++++++++++-----------
gtkdoc/mkhtml2.py | 8 +++---
gtkdoc/rebase.py | 2 +-
gtkdoc/scan.py | 2 +-
help/manual/C/index.docbook | 6 ++---
tests/annotations/docs/Makefile.am | 2 +-
tests/annotations/src/tester.h | 2 +-
tests/bugs/docs/Makefile.am | 2 +-
tests/empty/docs/Makefile.am | 2 +-
tests/fail/docs/Makefile.am | 2 +-
tests/gobject/docs/Makefile.am | 2 +-
tests/gobject/src/giface.c | 6 ++---
tests/gobject/src/gobject.c | 2 +-
tests/program/docs/Makefile.am | 2 +-
tests/repro/docs/Makefile.am | 2 +-
24 files changed, 84 insertions(+), 85 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index 6d5eb96..352073c 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -643,7 +643,7 @@
* configure.in:
Add automake support for more distcheck. Use a real sourcefile for the
- srcdir (something that we wont remove one day).
+ srcdir (something that we won't remove one day).
* tests/annotations/docs/Makefile.am:
* tests/annotations/src/Makefile.am:
@@ -658,7 +658,7 @@
2009-01-07 Stefan Kost <ensonic users sf net>
* TODO:
- Ideas about syntax highlighing.
+ Ideas about syntax highlighting.
* style-classic.css:
Old color scheme.
@@ -705,7 +705,7 @@
2008-12-05 Stefan Kost <ensonic users sf net>
* style.css:
- Hightlight deprecation warnings.
+ Highlight deprecation warnings.
2008-12-04 Stefan Kost <ensonic users sf net>
@@ -799,7 +799,7 @@
* gtk-doc.notmpl.make:
* tests/gtk-doc.make:
* tests/gtk-doc.notmpl.make:
- Correct check for existance of gtkdoc-rebase (better fix than the
+ Correct check for existence of gtkdoc-rebase (better fix than the
previous one #508897). Fixes #559281.
2008-10-27 Stefan Kost <ensonic users sf net>
@@ -950,7 +950,7 @@
2008-09-04 Stefan Kost <ensonic users sf net>
* gtkdoc-mkhtml.in:
- Fix comparision.
+ Fix comparison.
* TODO:
ideas.
@@ -1110,7 +1110,7 @@
* tests/gobject/examples/gobject.c:
* tests/gobject/src/gobject.c:
- Demostrate how to include source fragments from external files.
+ Demonstrate how to include source fragments from external files.
* tests/gobject/src/giface.h:
* tests/gobject/src/gobject.h:
@@ -1146,13 +1146,13 @@
* gtkdoc-mkdb.in:
Warn about repeated symbols in sections. Also give line of previous
- occurrance. Also give that info for double file entries. Fixes #473342
- Give correct error locate for one warning. Fixes #532395 partialy
+ occurrence. Also give that info for double file entries. Fixes #473342
+ Give correct error locate for one warning. Fixes #532395 partially
2008-06-04 Stefan Kost <ensonic users sf net>
* gtkdoc-mkdb.in:
- Don't warn about overriden docs comment if its the same text.
+ Don't warn about overridden docs comment if its the same text.
2008-06-03 Stefan Kost <ensonic users sf net>
@@ -1185,7 +1185,7 @@
tody up and add some comments regarding HTML_DIR.
* gtkdoc-fixxref.in:
- HTML_DIR is not neccesarily set.
+ HTML_DIR is not necessarily set.
* gtkdoc-mkhtml.in:
Fix uninstalled.
@@ -1197,7 +1197,7 @@
2008-06-02 Stefan Kost <ensonic users sf net>
* style.css:
- Improve spacing on indicies and glossaries.
+ Improve spacing on indices and glossaries.
2008-06-02 Stefan Kost <ensonic users sf net>
@@ -1464,7 +1464,7 @@
2007-12-17 Mathias Hasselmann <mathias openismus com>
* configure.in:
- Use AM_PATH_PYTHON instread of AC_PATH_PROG to find Python.
+ Use AM_PATH_PYTHON instead of AC_PATH_PROG to find Python.
(#503710)
2007-12-17 Stefan Kost <ensonic users sf net>
@@ -1513,7 +1513,7 @@
patch by: Kouhei Sutou <kou cozmixng org>
* gtk-doc.xsl:
- Consitently use UTF-8 instead of US-ASCII for output encoding.
+ Consistently use UTF-8 instead of US-ASCII for output encoding.
Fixes #497367
2007-12-10 Mathias Hasselmann <mathias openismus com>
@@ -1681,7 +1681,7 @@
2007-09-26 Stefan Kost <ensonic users sf net>
* gtk-doc.make:
- And actually saving before commiting might greatly help.
+ And actually saving before committing might greatly help.
2007-09-26 Stefan Kost <ensonic users sf net>
@@ -2574,7 +2574,7 @@
* Makefile.am (pkgconfigdir): put the .pc file in $(datadir) rather
than $(libdir), since gtk-doc is architecture-independant. (#120950)
- * configure.in: removed the hard dependancy on openjade or jade, since
+ * configure.in: removed the hard dependency on openjade or jade, since
XML is used mostly now rather than SGML. We just output a warning
rather than an error if neither openjade or jade are found.
@@ -2678,7 +2678,7 @@
* gtkdoc-mkdb.in:
fix parsing const after type (#322556)
* gtkdoc-mktmpl.in:
- fix parseing multiline macro heads (#320588)
+ fix parsing multiline macro heads (#320588)
* gtkdoc-scangobj.in:
allow additional root types (#323581)
@@ -3173,7 +3173,7 @@ Fri Jul 23 13:21:34 2004 Matthias Clasen <maclas gmx de>
2004-05-10 Geert Stappers <stappers stappers nl>
- * TODO: new file, basicly a reference to bugzilla.
+ * TODO: new file, basically a reference to bugzilla.
* examples/README: tell about gtk-doc.make.
@@ -3568,7 +3568,7 @@ Thu Jun 12 15:55:57 2003 Owen Taylor <otaylor redhat com>
2003-02-12 James Henstridge <james daa com au>
- * gtk-doc.make: add some chmod calls to work arround distcheck on
+ * gtk-doc.make: add some chmod calls to work around distcheck on
automake >= 1.6.
(install-data-local): copy the images as well as the html files
during install.
@@ -3967,7 +3967,7 @@ Tue Sep 17 01:07:51 2002 Jonathan Blandford <jrb gnome org>
than a <literallayout>, since the Docbook XSL stylesheets don't
handle <link>s inside <literallayout>.
- * gtkdoc-mkdb.in: Decide wether to generate standalone documents
+ * gtkdoc-mkdb.in: Decide whether to generate standalone documents
for XIncluding or entities based on the presence of the XInclude
namespace declaration on the document element.
@@ -4284,7 +4284,7 @@ Thu Jun 21 11:57:16 2001 Owen Taylor <otaylor redhat com>
2001-05-19 Damon Chaplin <damon ximian com>
* gtkdoc-mkdb.in: added --help option and changed output slightly to
- make more compatable with XML. Patch from Toshio Kuratomi
+ make more compatible with XML. Patch from Toshio Kuratomi
<badger prtr-13 ucsc edu>
2001-05-19 Damon Chaplin <damon ximian com>
@@ -4643,7 +4643,7 @@ Wed Feb 9 11:29:25 2000 Owen Taylor <otaylor redhat com>
1999-12-15 Raja R Harinath <harinath cs umn edu>
* gtk-doc.dsl.in ($generate-chapter-toc$): Add missing close
- paranthesis.
+ parenthesis.
1999-11-23 Raja R Harinath <harinath cs umn edu>
@@ -4754,7 +4754,7 @@ Wed Aug 4 04:04:55 1999 Owen Taylor <otaylor redhat com>
Wed Aug 4 03:30:19 1999 Owen Taylor <otaylor redhat com>
* doc/style-guide.txt: Removed references to creating
- tables explicitely in favor of demonstrating new
+ tables explicitly in favor of demonstrating new
syntax. Added a short section on /<* public >*/
and /*< private *>/.
@@ -4772,12 +4772,12 @@ Wed Aug 4 03:15:19 1999 Owen Taylor <otaylor redhat com>
enumeration have a description in a @... line, then
we don't generate the table at all.
- Also, gtkdoc-mktmpl now loads up the object heirarchy,
+ Also, gtkdoc-mktmpl now loads up the object hierarchy,
because we need to be able to check if structures
are widget structures.
In general, the coding here is pretty clean, though
- the style is a little different. (I'm interating
+ the style is a little different. (I'm iterating
through strings with m/.../msg; instead of
s/^...//; for one thing.) However, there are a some
of FIXME's where I've whimped out on try to handle
@@ -4975,7 +4975,7 @@ Wed Aug 4 03:15:19 1999 Owen Taylor <otaylor redhat com>
1998-12-16 Damon Chaplin <DAChaplin msn com>
- * gtkdoc-mkdb (ExpandAbbreviations): Allow -ve contants, e.g. %-1.
+ * gtkdoc-mkdb (ExpandAbbreviations): Allow -ve contents, e.g. %-1.
(ScanSourceFile): Try to handle function descriptions that start
with 'Returns'. It was assuming that they were describing the return
value before.
diff --git a/NEWS b/NEWS
index 46de939..84b6dbd 100644
--- a/NEWS
+++ b/NEWS
@@ -43,7 +43,7 @@ Bug fixes.
o 791928 : gtk-doc doesn't understand 'stability: Obsolete'
o 792148 : cmake: Installed GtkDocConfig.cmake has incorrect bindir path
- o 792661 : use pygments to do syntax highlighing
+ o 792661 : use pygments to do syntax highlighting
o 793599 : Please run testsuite with V=0
o 794051 : rebase: fix on-line location extraction from devhelp files
o 794182 : private_header regex is broken
@@ -751,7 +751,7 @@ GTK-Doc 1.11 (Nov 16 2008)
o 554718 : gtk-doc needs to allow versioned TARGET_DIR
o 554833 : Be more careful with " struct _ < struct_name > "
o 558082 : evince docs build fails with GTK_DISABLE_SINGLE_INCLUDES
- o 559281 : Correct check for existance of gtkdoc-rebase
+ o 559281 : Correct check for existence of gtkdoc-rebase
Contributors
@@ -908,7 +908,7 @@ GTK-Doc 1.7 (Jul 29 2006)
GTK-Doc 1.6 (Apr 9 2006)
===========
- o Removed the hard dependancy on openjade or jade, since XML is used mainly
+ o Removed the hard dependency on openjade or jade, since XML is used mainly
now rather than SGML.
o Install the .pc file in $(datadir) rather than $(libdir) since gtk-doc is
architecture-independant.
diff --git a/TODO b/TODO
index b1a35fe..05d85d3 100644
--- a/TODO
+++ b/TODO
@@ -1,10 +1,9 @@
-
The TODO list for the gtk-doc project is at Bugzilla,
the bugtracking system of the GNOME project.
Visit
http://bugzilla.gnome.org/buglist.cgi?product=gtk-doc&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED
-to see what is allready requested, or where you can help. :-)
+to see what is already requested, or where you can help. :-)
To put an other request on the TODO list, visit
http://bugzilla.gnome.org/enter_bug.cgi?product=gtk-doc
@@ -47,9 +46,9 @@ https://bugzilla.gnome.org/show_bug.cgi?id=646094
* if one has "@InSection: xxxx" in a section comment we could patch the
main.xml file and insert then xi:include line (would possibly rely on a
special comment-pair there, we might also need to rewrite these
- auto-generated xi:includes everytime as the placements could have been
- changed, or we have a xi:inlcude for each chapter, that we regenerate).
-* we need a way to specify subsections (Standart, Private)
+ auto-generated xi:includes every time as the placements could have been
+ changed, or we have a xi:include for each chapter, that we regenerate).
+* we need a way to specify subsections (Standard, Private)
this could be done in the SECTION comment
e.g.: "@HideSymbols: <list-of-symbols-to-hide>
* we could allow to have a SUBSECTION:xxx comment block too
@@ -300,7 +299,7 @@ all matching declarations in one source listing. Multiple wildcards are okay.
* api - classic api docs
* tutorial & examples - integrated to keep it up-to-date and cross referenced
* migration - how to for api changes, deprecations
- * (releated) tools - tools part of the package or recommended for development
+ * (related) tools - tools part of the package or recommended for development
* indexes - api-index, depretations, new api since xxx
proposed structure in docbook xml:
@@ -392,7 +391,7 @@ grep "gst_caps_is_always_compatible" tags
- l10n.language is slow
bug: https://sourceforge.net/tracker/index.php?func=detail&aid=2918673&group_id=21935&atid=373750
see: http://www.mail-archive.com/docbook-apps lists oasis-open org/msg05412.html
- - overide l10n.language
+ - override l10n.language
glib/gobject
real user sys
2m15.221s 1m58.740s 0m1.456s
@@ -458,7 +457,7 @@ grep "gst_caps_is_always_compatible" tags
- tricky as with xml/gtkdocentities.ent, they are in a extra file
- we could pass entities as args for gtkdoc-mkdb
- if the flag is used, we should warn if entities are in the header
- - 2) if the doctype on the main doc, does not conatin entities, skip adding
+ - 2) if the doctype on the main doc, does not cotnain entities, skip adding
the doctype to generated output
- 3) if the doctype on the main doc contains entities, only add the doctype
if the generated content contains entities ([&%][_a-zA-Z]*;)
@@ -476,7 +475,7 @@ find . -name "*.xml" -exec egrep -o '&[_a-zA-Z]*;' {} \; | sort | uniq -c | sort
- consider swithcing to this markdown parser
https://pythonhosted.org/Markdown/index.html
- switch intermediate files to json/yaml
- - we need to pick something, that we can easilly output from plain c (produced by gtkdoc-scangobj)
+ - we need to pick something, that we can easily output from plain c (produced by gtkdoc-scangobj)
- decl-list.txt and .types would need to stay
- maybe maintain one file per sourcefile (in a subdir) to eventually be able to
do incremental builds
diff --git a/devhelp2.xsd b/devhelp2.xsd
index a0b96dc..899630d 100644
--- a/devhelp2.xsd
+++ b/devhelp2.xsd
@@ -39,7 +39,7 @@ xsltproc -o devhelp2.xsd.html $HOME/download/xs3p-1.1.3/xs3p.xsl devhelp2.xsd
<xsd:simpleType name="language-type">
<xsd:annotation>
<xsd:documentation>
- Known programing languages.
+ Known programming languages.
</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
@@ -58,7 +58,7 @@ xsltproc -o devhelp2.xsd.html $HOME/download/xs3p-1.1.3/xs3p.xsl devhelp2.xsd
<xsd:element name="sub">
<xsd:annotation>
<xsd:documentation>
- Sub tags for the hierachy of the chapters and parts.
+ Sub tags for the hierarchy of the chapters and parts.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
@@ -201,7 +201,7 @@ xsltproc -o devhelp2.xsd.html $HOME/download/xs3p-1.1.3/xs3p.xsl devhelp2.xsd
<xsd:attribute name="language" type="language-type">
<xsd:annotation>
<xsd:documentation>
- Programing language this manual refers to.
+ Programming language this manual refers to.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
diff --git a/doc/design-2.x.txt b/doc/design-2.x.txt
index 7b61637..0f4abed 100644
--- a/doc/design-2.x.txt
+++ b/doc/design-2.x.txt
@@ -14,8 +14,8 @@ g-doc, gapi-doc, gnome-api-doc, ...
sgml.stamp -> db.stamp
== design fixes ==
-=== proper xml-id namesspaces ===
-We need proper xml-id namesspaces for document structure and symbols to avoid
+=== proper xml-id namespaces ===
+We need proper xml-id namespaces for document structure and symbols to avoid
clashes e.g. between GtkWidget as a section and as a struct. Normal symbols
should only be mangled to be a valid xml-id. Document structure ids should
contain a prefix.
@@ -109,7 +109,7 @@ tools/db2md.py).
Add the new makefile flavour to run gtkdoc-mkhtml2 instead. Add --flavour
options for gtkdocize. Create a stub gtkdoc-mkhtml2 tool.
-3.) [in progress] refactor gtkdoc/mkdb.py to exctract reusable code
+3.) [in progress] refactor gtkdoc/mkdb.py to extract reusable code
- gtkdoc/md_to_db.py
- only have the parse there
diff --git a/doc/gtkdoc.dot b/doc/gtkdoc.dot
index 5bffa56..a5fd240 100644
--- a/doc/gtkdoc.dot
+++ b/doc/gtkdoc.dot
@@ -37,7 +37,7 @@ digraph gtkdoc {
module_undocumented [label="*-undocumented.txt" ];
module_unused [label="*-unused.txt" ];
- /* tool invokation */
+ /* tool invocation */
gtkdoc_scan -> gtkdoc_scangobj -> gtkdoc_mkdb -> gtkdoc_mkhtml -> gtkdoc_fixxref -> gtkdoc_rebase ->
gtkdoc_check [style="dotted"];
/* file usage */
diff --git a/examples/Makefile.am b/examples/Makefile.am
index bf1d41f..1c0d907 100644
--- a/examples/Makefile.am
+++ b/examples/Makefile.am
@@ -84,7 +84,7 @@ HTML_IMAGES=
# e.g. content_files=running.xml building.xml changes-2.0.xml
content_files=
-# Files where gtk-doc abbrevations (#GtkWidget) are expanded
+# Files where gtk-doc abbreviations (#GtkWidget) are expanded
# e.g. expand_content_files=running.xml
expand_content_files=
diff --git a/gtk-doc.xsl b/gtk-doc.xsl
index 3471e6c..1a7a1ee 100644
--- a/gtk-doc.xsl
+++ b/gtk-doc.xsl
@@ -6,7 +6,7 @@
<!-- import the chunked XSL stylesheet -->
<!-- http://www.sagehill.net/docbookxsl/Chunking.html#FastChunking says we should use
- "chunkfast.xsl", but I can't see a difference. Also it is not clear wheter
+ "chunkfast.xsl", but I can't see a difference. Also it is not clear whether
one should still set "chunk.fast". Again, no meassuable difference. -->
<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/chunk.xsl"/>
<xsl:include href="devhelp2.xsl"/>
@@ -66,7 +66,7 @@
<!-- ========================================================= -->
<!-- l10n is slow, we don't ue it, so we'd like to turn it off
- this atleast avoid the re-evaluation -->
+ this at least avoid the re-evaluation -->
<xsl:template name="l10n.language">en</xsl:template>
<xsl:param name="gtkdoc.l10n.xml"
select="document('http://docbook.sourceforge.net/release/xsl/current/common/en.xml')"/>
@@ -484,7 +484,7 @@ Get a newer version at http://docbook.sourceforge.net/projects/xsl/
</xsl:when>
<!-- this is not yet very nice, as it requires all glossdic/indexdiv
elements having a anchor element. maybe we can customize the xsl
- to automaticaly create local anchors
+ to automatically create local anchors
-->
<xsl:when test="count($glssections) > 0">
<span id="nav_glossary">
diff --git a/gtkdoc/fixxref.py b/gtkdoc/fixxref.py
index daba928..0a7bd6b 100755
--- a/gtkdoc/fixxref.py
+++ b/gtkdoc/fixxref.py
@@ -73,7 +73,7 @@ def LoadIndicies(module_dir, html_dir, extra_dirs):
prefix_match = r'^' + re.escape(path_prefix) + r'/'
# We scan the directory containing GLib and any directories in GNOME2_PATH
- # first, but these will be overriden by any later scans.
+ # first, but these will be overridden by any later scans.
dir = common.GetModuleDocDir('glib-2.0')
if dir and os.path.exists(dir):
# Some predefined link targets to get links into type hierarchies as these
@@ -357,7 +357,7 @@ def MakeXRef(module, file, line, id, text):
def MakeGtkDocLink(pre, symbol, post):
id = common.CreateValidSGMLID(symbol)
- # these are implicitely created links in highlighed sources
+ # these are implicitly created links in highlighted sources
# we don't want warnings for those if the links cannot be resolved.
NoLinks.add(id)
diff --git a/gtkdoc/mkdb.py b/gtkdoc/mkdb.py
index 37a6931..a306655 100644
--- a/gtkdoc/mkdb.py
+++ b/gtkdoc/mkdb.py
@@ -1208,7 +1208,7 @@ def OutputMacro(symbol, declaration):
declaration (str): the declaration of the macro.
Returns:
- str: the formated docs
+ str: the formatted docs
"""
sid = common.CreateValidSGMLID(symbol)
condition = MakeConditionDescription(symbol)
@@ -1273,7 +1273,7 @@ def OutputTypedef(symbol, declaration):
e.g. 'typedef unsigned int guint;'
Returns:
- str: the formated docs
+ str: the formatted docs
"""
sid = common.CreateValidSGMLID(symbol)
condition = MakeConditionDescription(symbol)
@@ -1311,7 +1311,7 @@ def OutputStruct(symbol, declaration):
declaration (str): the declaration of the struct.
Returns:
- str: the formated docs
+ str: the formatted docs
"""
is_gtype = False
default_to_public = True
@@ -1508,7 +1508,7 @@ def OutputUnion(symbol, declaration):
declaration (str): the declaration of the union.
Returns:
- str: the formated docs
+ str: the formatted docs
"""
is_gtype = False
if CheckIsObject(symbol):
@@ -1645,7 +1645,7 @@ def OutputEnum(symbol, declaration):
declaration (str): the declaration of the enum.
Returns:
- str: the formated docs
+ str: the formatted docs
"""
is_gtype = False
if CheckIsObject(symbol):
@@ -1762,7 +1762,7 @@ def OutputVariable(symbol, declaration):
declaration (str): the declaration of the variable.
Returns:
- str: the formated docs
+ str: the formatted docs
"""
sid = common.CreateValidSGMLID(symbol)
condition = MakeConditionDescription(symbol)
@@ -1826,7 +1826,7 @@ def OutputFunction(symbol, declaration, symbol_type):
declaration (str): the declaration of the function.
Returns:
- str: the formated docs
+ str: the formatted docs
"""
sid = common.CreateValidSGMLID(symbol)
condition = MakeConditionDescription(symbol)
@@ -1924,7 +1924,7 @@ def OutputParamDescriptions(symbol_type, symbol, fields):
undocumented/unused entries
Returns:
- str: the formated parameter docs
+ str: the formatted parameter docs
"""
output = ''
num_params = 0
@@ -2942,7 +2942,7 @@ def MakeIndexterms(symbol, sid):
terms = ''
sortas = ''
- # make the index useful, by ommiting the namespace when sorting
+ # make the index useful, by omitting the namespace when sorting
if NAME_SPACE != '':
m = re.search(r'^%s\_?(.*)' % NAME_SPACE, symbol, flags=re.I)
if m:
@@ -3000,10 +3000,10 @@ def MakeDeprecationNote(symbol):
def MakeConditionDescription(symbol):
- """This returns a sumary of conditions for the given symbol.
+ """This returns a summary of conditions for the given symbol.
Args:
- symbol (str): the symbol to create the sumary for.
+ symbol (str): the symbol to create the summary for.
Returns:
str: formatted text or empty string if no special conditions apply.
@@ -3076,7 +3076,7 @@ def GetHierarchy(gobject, hierarchy):
if not found:
return hierarchy
- logging.info("=== Hierachy for: %s (%d existing entries) ===", gobject, len(hierarchy))
+ logging.info("=== Hierarchy for: %s (%d existing entries) ===", gobject, len(hierarchy))
# Walk up the hierarchy, pushing ancestors onto the ancestors array.
ancestors = [gobject]
@@ -3358,7 +3358,7 @@ def GetSignals(gobject):
if j < len(sourceparam_names):
param_name = sourceparam_names[j]
logging.info('from sourceparams: "%s" (%d: %s)', param_name, j, params[j])
- # we're mssing the docs for this param, don't warn here though
+ # we're missing the docs for this param, don't warn here though
else:
param_name = m.group(3)
logging.info('from params: "%s" (%d: %s)', param_name, j, params[j])
@@ -4166,7 +4166,7 @@ def MergeSourceDocumentation():
the template files.
"""
- # add whats found in the source
+ # add what's found in the source
symbols = set(SourceSymbolDocs.keys())
# and add known symbols from -sections.txt
diff --git a/gtkdoc/mkhtml2.py b/gtkdoc/mkhtml2.py
index fef4876..e8631fe 100644
--- a/gtkdoc/mkhtml2.py
+++ b/gtkdoc/mkhtml2.py
@@ -31,7 +31,7 @@ and source-highlight.
Please note, that we're not aiming for complete docbook-xml support. All tags
used in the generated xml are of course handled. More tags used in handwritten
-xml can be easilly supported, but for some combinations of tags we prefer
+xml can be easily supported, but for some combinations of tags we prefer
simplicity.
TODO:
@@ -135,7 +135,7 @@ DONT_CHUNK = float('inf')
# docbook xsl does.
#
# For toc levels see http://www.sagehill.net/docbookxsl/TOCcontrol.html
-# TODO: this list has also a flag that controls wheter we add the
+# TODO: this list has also a flag that controls whether we add the
# 'Table of Contents' heading in convert_chunk_with_toc()
CHUNK_PARAMS = {
'appendix': ChunkParams('app', 'book'),
@@ -1766,7 +1766,7 @@ def get_dirs(uninstalled):
def main(module, index_file, out_dir, uninstalled, src_lang, paths):
# == Loading phase ==
- # the next 3 steps could be done in paralel
+ # the next 3 steps could be done in parallel
# 1) load the docuemnt
_t = timer()
@@ -1795,7 +1795,7 @@ def main(module, index_file, out_dir, uninstalled, src_lang, paths):
# 3) load xref targets
_t = timer()
# TODO: migrate options from fixxref
- # TODO: ideally explicity specify the files we need, this will save us the
+ # TODO: ideally explicitly specify the files we need, this will save us the
# globbing and we'll load less files.
fixxref.LoadIndicies(out_dir, '/usr/share/gtk-doc/html', [])
logging.warning("3: %7.3lf: load xrefs", timer() - _t)
diff --git a/gtkdoc/rebase.py b/gtkdoc/rebase.py
index 4b0266c..0cefed0 100755
--- a/gtkdoc/rebase.py
+++ b/gtkdoc/rebase.py
@@ -53,7 +53,7 @@ def run(options):
other_dirs = []
# We scan the directory containing GLib and any directories in GNOME2_PATH
- # first, but these will be overriden by any later scans.
+ # first, but these will be overridden by any later scans.
if "GNOME2_PATH" in os.environ:
for dir in os.environ["GNOME2_PATH"].split(':'):
dir = os.path.join(dir, "share/gtk-doc/html")
diff --git a/gtkdoc/scan.py b/gtkdoc/scan.py
index f1f1672..406b54c 100644
--- a/gtkdoc/scan.py
+++ b/gtkdoc/scan.py
@@ -736,7 +736,7 @@ def ScanHeader(input_file, section_list, decl_list, get_types, options):
deprecated_conditional_nest = int(deprecated_conditional_nest)
in_declaration = ''
- # We try to handle nested stucts/unions, but unmatched brackets in
+ # We try to handle nested structs/unions, but unmatched brackets in
# comments will cause problems.
if in_declaration == 'struct' or in_declaration == 'union':
sm = re.search(r'\n\}\s*(\w*);\s*$', decl)
diff --git a/help/manual/C/index.docbook b/help/manual/C/index.docbook
index 6147941..384e27e 100644
--- a/help/manual/C/index.docbook
+++ b/help/manual/C/index.docbook
@@ -352,7 +352,7 @@
<title>About GTK-Doc</title>
<para>
- Historically GTK-Doc was used to generate template files from the soures
+ Historically GTK-Doc was used to generate template files from the sources
code. These template files could be used by developers to enter the
API documentation. This approach was rather inconvenient because it
required to keep the generated files under version control.
@@ -689,7 +689,7 @@ meep/
<para>
<option>expand_content_files</option>
allows to specify files
- where <emphasis>gtk-doc abbrevations</emphasis> such as
+ where <emphasis>gtk-doc abbreviations</emphasis> such as
<code>#GtkWidget</code>
are expanded (e.g. <code>
expand_content_files=running.xml</code>).
@@ -1771,7 +1771,7 @@ typedef enum {
<term>Returns:</term>
<listitem>
<para>
- Specificy what value(s) the program returns. (Optional)
+ Specify what value(s) the program returns. (Optional)
</para>
</listitem>
</varlistentry>
diff --git a/tests/annotations/docs/Makefile.am b/tests/annotations/docs/Makefile.am
index 08e6d4b..8cf5c7b 100644
--- a/tests/annotations/docs/Makefile.am
+++ b/tests/annotations/docs/Makefile.am
@@ -45,7 +45,7 @@ HTML_IMAGES =
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
content_files =
-# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# SGML files where gtk-doc abbreviations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
# e.g. expand_content_files=running.sgml
expand_content_files=
diff --git a/tests/annotations/src/tester.h b/tests/annotations/src/tester.h
index 1a4a68b..002de4a 100644
--- a/tests/annotations/src/tester.h
+++ b/tests/annotations/src/tester.h
@@ -6,7 +6,7 @@
/**
* GtkdocAnnotation:
- * @that: (allow-none): eventualy points to something
+ * @that: (allow-none): eventually points to something
*
* small struct
*/
diff --git a/tests/bugs/docs/Makefile.am b/tests/bugs/docs/Makefile.am
index 24052f7..7e3643c 100644
--- a/tests/bugs/docs/Makefile.am
+++ b/tests/bugs/docs/Makefile.am
@@ -46,7 +46,7 @@ HTML_IMAGES =
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
content_files =
-# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# SGML files where gtk-doc abbreviations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
# e.g. expand_content_files=running.sgml
expand_content_files=
diff --git a/tests/empty/docs/Makefile.am b/tests/empty/docs/Makefile.am
index 600c3ea..3fb5d69 100644
--- a/tests/empty/docs/Makefile.am
+++ b/tests/empty/docs/Makefile.am
@@ -51,7 +51,7 @@ HTML_IMAGES =
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
content_files =
-# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# SGML files where gtk-doc abbreviations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
# e.g. expand_content_files=running.sgml
expand_content_files=
diff --git a/tests/fail/docs/Makefile.am b/tests/fail/docs/Makefile.am
index 27222d4..c715afd 100644
--- a/tests/fail/docs/Makefile.am
+++ b/tests/fail/docs/Makefile.am
@@ -45,7 +45,7 @@ HTML_IMAGES =
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
content_files =
-# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# SGML files where gtk-doc abbreviations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
# e.g. expand_content_files=running.sgml
expand_content_files=
diff --git a/tests/gobject/docs/Makefile.am b/tests/gobject/docs/Makefile.am
index 45a5b46..bae229d 100644
--- a/tests/gobject/docs/Makefile.am
+++ b/tests/gobject/docs/Makefile.am
@@ -49,7 +49,7 @@ HTML_IMAGES = \
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
content_files =
-# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# SGML files where gtk-doc abbreviations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
# e.g. expand_content_files=running.sgml
expand_content_files=
diff --git a/tests/gobject/src/giface.c b/tests/gobject/src/giface.c
index 5378a80..99d7c5d 100644
--- a/tests/gobject/src/giface.c
+++ b/tests/gobject/src/giface.c
@@ -15,8 +15,8 @@
* <caption><para>Home sweet home.</para></caption>
* </mediaobject>
*
- * Just incase you wonder, special caracters can be escaped with a \ like in \%
- * or \# or even \@.
+ * Just in case you wonder, special characters can be escaped with a \ like
+ * in \% or \# or even \@.
*
* We also support verbatim spans - lets test escaping of a `<tag>` block.
*/
@@ -41,7 +41,7 @@
*
* Configure a new instance
*
- * Returns: %TRUE for sucess or %FALSE in case of an error
+ * Returns: %TRUE for success or %FALSE in case of an error
*
* Since: 0.1
*/
diff --git a/tests/gobject/src/gobject.c b/tests/gobject/src/gobject.c
index f4a783c..b23628d 100644
--- a/tests/gobject/src/gobject.c
+++ b/tests/gobject/src/gobject.c
@@ -30,7 +30,7 @@
* frobnicator.
*
* A new instance can be created using the gtkdoc_object_new() function. The
- * whole lifecycle usualy looks like shown in this example:
+ * whole lifecycle usually looks like shown in this example:
* |[<!-- language="C" -->
* #include <glib.h>
* #include <glib-object.h>
diff --git a/tests/program/docs/Makefile.am b/tests/program/docs/Makefile.am
index fdcd2b5..468c01c 100644
--- a/tests/program/docs/Makefile.am
+++ b/tests/program/docs/Makefile.am
@@ -45,7 +45,7 @@ HTML_IMAGES =
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
content_files =
-# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# SGML files where gtk-doc abbreviations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
# e.g. expand_content_files=running.sgml
expand_content_files=
diff --git a/tests/repro/docs/Makefile.am b/tests/repro/docs/Makefile.am
index 5480011..ed9bf2a 100644
--- a/tests/repro/docs/Makefile.am
+++ b/tests/repro/docs/Makefile.am
@@ -44,7 +44,7 @@ HTML_IMAGES =
# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
content_files =
-# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
+# SGML files where gtk-doc abbreviations (#GtkWidget) are expanded
# These files must be listed here *and* in content_files
# e.g. expand_content_files=running.sgml
expand_content_files=
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
