summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2009-12-13 20:54:52 +0000
committeralberth <alberth@openttd.org>2009-12-13 20:54:52 +0000
commit57e6c7fdb726f2aca6818617cc4b1eda0ba72b9a (patch)
treebf2ba65c21812eff168a3dd51aafa80682358f02
parent7c4eaf73a78b0265b629bb91c9c03d7a6f5032b9 (diff)
downloadopenttd-57e6c7fdb726f2aca6818617cc4b1eda0ba72b9a.tar.xz
(svn r18490) -Doc: Fixed syntax of a few doxygen pre and post coditions.
-rw-r--r--src/graph_gui.cpp6
-rw-r--r--src/widget.cpp4
-rw-r--r--src/widget_type.h2
3 files changed, 6 insertions, 6 deletions
diff --git a/src/graph_gui.cpp b/src/graph_gui.cpp
index 5426e1a77..e82964e8e 100644
--- a/src/graph_gui.cpp
+++ b/src/graph_gui.cpp
@@ -107,7 +107,7 @@ struct GraphLegendWindow : Window {
* Construct a vertical list of buttons, one for each company.
* @param biggest_index Storage for collecting the biggest index used in the returned tree.
* @return Panel with company buttons.
- * @postcond \c *biggest_index contains the largest used index in the tree.
+ * @post \c *biggest_index contains the largest used index in the tree.
*/
static NWidgetBase *MakeNWidgetCompanyLines(int *biggest_index)
{
@@ -1375,7 +1375,7 @@ CompanyID PerformanceRatingDetailWindow::company = INVALID_COMPANY;
/** Make a vertical list of panels for outputting score details.
* @param biggest_index Storage for collecting the biggest index used in the returned tree.
* @return Panel with performance details.
- * @postcond \c *biggest_index contains the largest used index in the tree.
+ * @post \c *biggest_index contains the largest used index in the tree.
*/
static NWidgetBase *MakePerformanceDetailPanels(int *biggest_index)
{
@@ -1409,7 +1409,7 @@ static NWidgetBase *MakePerformanceDetailPanels(int *biggest_index)
* Make a number of rows with button-like graphics, for enabling/disabling each company.
* @param biggest_index Storage for collecting the biggest index used in the returned tree.
* @return Panel with rows of company buttons.
- * @postcond \c *biggest_index contains the largest used index in the tree.
+ * @post \c *biggest_index contains the largest used index in the tree.
*/
static NWidgetBase *MakeCompanyButtonRows(int *biggest_index)
{
diff --git a/src/widget.cpp b/src/widget.cpp
index fd01b65f6..aaf36ad17 100644
--- a/src/widget.cpp
+++ b/src/widget.cpp
@@ -2089,7 +2089,7 @@ bool NWidgetLeaf::ButtonHit(const Point &pt)
* @param fill_dest Fill the composed widget with child widgets.
* @param biggest_index Pointer to biggest nested widget index in the tree encountered so far.
* @return Number of widget part elements used to compose the widget.
- * @precond \c biggest_index != NULL.
+ * @pre \c biggest_index != NULL.
*/
static int MakeNWidget(const NWidgetPart *parts, int count, NWidgetBase **dest, bool *fill_dest, int *biggest_index)
{
@@ -2237,7 +2237,7 @@ static int MakeNWidget(const NWidgetPart *parts, int count, NWidgetBase **dest,
* @param parent Container to use for storing the child widgets.
* @param biggest_index Pointer to biggest nested widget index in the tree.
* @return Number of widget part elements used to fill the container.
- * @postcond \c *biggest_index contains the largest widget index of the tree and \c -1 if no index is used.
+ * @post \c *biggest_index contains the largest widget index of the tree and \c -1 if no index is used.
*/
static int MakeWidgetTree(const NWidgetPart *parts, int count, NWidgetBase *parent, int *biggest_index)
{
diff --git a/src/widget_type.h b/src/widget_type.h
index 9f90e8339..8cc214888 100644
--- a/src/widget_type.h
+++ b/src/widget_type.h
@@ -557,7 +557,7 @@ struct NWidgetPartTextLines {
/** Pointer to function returning a nested widget.
* @param biggest_index Pointer to storage for collecting the biggest index used in the nested widget.
* @return Nested widget (tree).
- * @postcond \c *biggest_index must contain the value of the biggest index in the returned tree.
+ * @post \c *biggest_index must contain the value of the biggest index in the returned tree.
*/
typedef NWidgetBase *NWidgetFunctionType(int *biggest_index);