From: Emil Hessman <248952+ceh@users.noreply.github.com>
Date: Mon, 5 Aug 2019 18:39:23 +0000 (+0000)
Subject: Docs: Fix Programming Guide typos (#448)
X-Git-Tag: SQUID_5_0_1~63
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=a4029d6ddd5ba8c4b988e804a7e7df6a00f42e6f;p=thirdparty%2Fsquid.git

Docs: Fix Programming Guide typos (#448)
---

diff --git a/doc/Programming-Guide/02_CodingConventions.dox b/doc/Programming-Guide/02_CodingConventions.dox
index 5948e1dc9c..107b016479 100644
--- a/doc/Programming-Guide/02_CodingConventions.dox
+++ b/doc/Programming-Guide/02_CodingConventions.dox
@@ -39,15 +39,15 @@
 \subsection CommentComponents	API vs Internal Component Commenting
 
 \par
-	First among these is a definition seperation between component API
+	First among these is a definition separation between component API
 	and Internal operations. API functions and objects should always be
-	commented and in the *.h file for the component. Internal logics and
+	commented and in the *.h file for the component. Internal logic and
 	objects should be commented in the *.cc file where they are defined.
         The group is to be defined in the components main files with the
 	overview paragraphs about the API usage or component structure.
 
 \par
-	With C++ classes it is easy to seperate API and Internals with the C++
+	With C++ classes it is easy to separate API and Internals with the C++
 	public: and private: distinctions on whichever class defines the
 	component API. An Internal group may not be required if there are no
 	additional items in the Internals (rare as globals are common in squid).
@@ -121,7 +121,7 @@ X::getFubar(char *g, int glen)
 \verbatim
 /**
  \retval 0	when FUBAR does not start with 'F'
- \retval 1	when FUBAR startes with F
+ \retval 1	when FUBAR starts with F
  */
 int
 X::saidFubar()
@@ -129,7 +129,7 @@ X::saidFubar()
 \endverbatim
 
 \par	Alternatively
-	when a state or other context-dependant object is returned the \b \\return
+	when a state or other context-dependent object is returned the \b \\return
 	tag is used. It is followed by a description of the object and ideally its
 	content.
 
@@ -143,7 +143,7 @@ X::saidFubar()
 
 \par	Long or Complex Functions
 	do however need some commenting.
-	A well-designed function does all its operatons in distinct blocks;
+	A well-designed function does all its operations in distinct blocks;
 	\arg Input validation
 	\arg Processing on some state
 	\arg Processing on the output of that earlier processing
diff --git a/doc/Programming-Guide/03_MajorComponents.dox b/doc/Programming-Guide/03_MajorComponents.dox
index 94353dadca..bd21a36f15 100644
--- a/doc/Programming-Guide/03_MajorComponents.dox
+++ b/doc/Programming-Guide/03_MajorComponents.dox
@@ -210,7 +210,7 @@
 	the callback function is executed.  The routines in cbdata.c
 	provide a uniform method for managing callback data memory,
 	canceling callbacks, and preventing erroneous memory accesses.
-\todo DOCS: get callback_data (object?) linking or repalcement named.
+\todo DOCS: get callback_data (object?) linking or replacement named.
 
 \section RefCountDataAllocator Refcount Data Allocator
 \since Squid 3.0
diff --git a/doc/Programming-Guide/DelayPools.dox b/doc/Programming-Guide/DelayPools.dox
index ad332ebeb4..c082eceddd 100644
--- a/doc/Programming-Guide/DelayPools.dox
+++ b/doc/Programming-Guide/DelayPools.dox
@@ -13,7 +13,7 @@
 \par
 	A DelayPool is a Composite used to manage bandwidth for any request
 	assigned to the pool by an access expression. DelayId's are a used
-	to manage the bandwith on a given request, whereas a DelayPool 
+	to manage the bandwidth on a given request, whereas a DelayPool
 	manages the bandwidth availability and assigned DelayId's.
 
 \section ExtendingDelayPools Extending Delay Pools
@@ -23,7 +23,7 @@
 	delay pool functions:
 	\li	stats() - provide cachemanager statistics for itself.
 	\li	dump() - generate squid.conf syntax for the current configuration of the item.
-	\li	update() - allocate more bandwith to all buckets in the item.
+	\li	update() - allocate more bandwidth to all buckets in the item.
 	\li	parse() - accept squid.conf syntax for the item, and configure for use appropriately.
 	\li	id() - return a DelayId entry for the current item.
 
diff --git a/doc/Programming-Guide/Groups.dox b/doc/Programming-Guide/Groups.dox
index e57f5b3258..6ee30b76a4 100644
--- a/doc/Programming-Guide/Groups.dox
+++ b/doc/Programming-Guide/Groups.dox
@@ -52,7 +52,7 @@
  *      Any good application has a set of tests to ensure it stays
  *      in a good condition. Squid tends to use cppunit tests.
  \par
- *      It is preferrable to automated tests for units of functionality. There
+ *      It is preferable to automated tests for units of functionality. There
  *      is a boilerplate for tests in "src/tests/testBoilerplate.[cc|h]". New
  *      tests need to be added to src/Makefile.am to build and run them during
  *      "make check". To add a new test script, just copy the references to
@@ -68,7 +68,7 @@
  * 
  \par
  *      Squid uses events to process asynchronous actions.
- *      These mehods are registered as callbacks to receive notice whenever a
+ *      These methods are registered as callbacks to receive notice whenever a
  *      specific event occurs.
  */