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

@@ @@ -104,13 +104,13 @@ 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)
+{
 	NWidgetVertical *vert = new NWidgetVertical();
 	for (int widnum = GLW_FIRST_COMPANY; widnum <= GLW_LAST_COMPANY; widnum++) {
@@ @@ -1372,13 +1372,13 @@ struct PerformanceRatingDetailWindow : W @@
 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)
+{
 	const StringID performance_tips[] = {
 		STR_PERFORMANCE_DETAIL_VEHICLES_TOOLTIP,
 		STR_PERFORMANCE_DETAIL_STATIONS_TOOLTIP,
@@ @@ -1406,13 +1406,13 @@ 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)
+{
 	static const int MAX_LENGTH = 8; // Maximal number of company buttons in one row.
 	NWidgetVertical *vert = NULL; // Storage for all rows.
 	NWidgetHorizontal *hor = NULL; // Storage for buttons in one row.

src/widget.cpp

➞

Show inline comments

@@ @@ -2086,13 +2086,13 @@ bool NWidgetLeaf::ButtonHit(const Point @@
  * @param parts Array with parts of the nested widget.
  * @param count Length of the \a parts array.
  * @param dest  Address of pointer to use for returning the composed widget.
  * @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)
+{
 	int num_used = 0;
 	*dest = NULL;
@@ @@ -2234,13 +2234,13 @@ static int MakeNWidget(const NWidgetPart @@
  * Build a nested widget tree by recursively filling containers with nested widgets read from their parts.
  * @param parts  Array with parts of the nested widgets.
  * @param count  Length of the \a parts array.
  * @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)
+{
 	/* Given parent must be either a #NWidgetContainer or a #NWidgetBackground object. */
 	NWidgetContainer *nwid_cont = dynamic_cast<NWidgetContainer *>(parent);
 	NWidgetBackground *nwid_parent = dynamic_cast<NWidgetBackground *>(parent);

src/widget_type.h

➞

Show inline comments

@@ @@ -554,13 +554,13 @@ struct NWidgetPartTextLines { @@
 	FontSize size; ///< Font size of text lines.
 };
 /** 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);
 /** Partial widget specification to allow NWidgets to be written nested.
  * @ingroup NestedWidgetParts */
 struct NWidgetPart {

0 comments (0 inline, 0 general)