cpp/openttd-patchpack/source Changeset - r13944:3617e6825e88

Changeset - r13944:3617e6825e88

Parent rev.

Child rev.

[Not reviewed]

master

0 3 0

alberth - 14 years ago 2009-12-13 20:54:52
alberth@openttd.org

(svn r18490) -Doc: Fixed syntax of a few doxygen pre and post coditions.

3 files changed with 6 insertions and 6 deletions:

src/graph_gui.cpp

src/widget.cpp

src/widget_type.h

0 comments (0 inline, 0 general)

src/graph_gui.cpp

➞

Show inline comments

@@ @@ -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: @@
 /** 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 *MakePerformanceDetai @@
  * 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)
+{

src/widget.cpp

➞

Show inline comments

@@ @@ -2089,7 +2089,7 @@ bool NWidgetLeaf::ButtonHit(const Point @@
  * @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 @@
  * @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)
+{

src/widget_type.h

➞

Show inline comments

@@ @@ -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);

0 comments (0 inline, 0 general)