Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix docs for wxGrid and friends

Browse Source 
Add a couple of missing @name commands; the corresponding comments were
appearing in the wrong place without them.

Avoid unintended effects of JAVADOC_AUTOBRIEF by using Qt-style comments
instead of Javadoc.

A couple of minor wording corrections.

See https://github.com/wxWidgets/wxWidgets/pull/175

(this is a backport of 9c95b398c8 from master)
This commit is contained in:
bogiord
2016-01-18 17:44:20 +02:00
committed by Vadim Zeitlin
parent 402219ed13
commit 2fdc7196a3
1 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
interface/wx/grid.h
View File

@@ -1168,12 +1168,12 @@ public:
virtual wxGridCellAttr *GetAttr(int row, int col, virtual wxGridCellAttr *GetAttr(int row, int col,
wxGridCellAttr::wxAttrKind kind) const; wxGridCellAttr::wxAttrKind kind) const;
/** /*!
Setting attributes. @name Setting attributes.
All these functions take ownership of the attribute passed to them, All these functions take ownership of the attribute passed to them,
i.e. will call DecRef() on it themselves later and so it should not be i.e. will call DecRef() on it themselves later and so it should not be
destroyed by the caller. And the attribute can be @NULL to reset a destroyed by the caller. The attribute can be @NULL to reset a
previously set value. previously set value.
*/ */
//@{ //@{
@@ -1190,7 +1190,7 @@ public:
//@} //@}
/** /**
Getting header renderers. @name Getting header renderers.
These functions return the renderers for the given row or column header These functions return the renderers for the given row or column header
label and the corner window. Unlike cell attributes, these objects are label and the corner window. Unlike cell attributes, these objects are
@@ -1527,13 +1527,14 @@ public:
virtual wxGrid *GetView() const; virtual wxGrid *GetView() const;
/** /*!
@name Table Structure Modifiers @name Table Structure Modifiers
Notice that none of these functions are pure virtual as they don't have Note that none of these functions are pure virtual as they don't have
to be implemented if the table structure is never modified after to be implemented if the table structure is never modified after
creation, i.e. neither rows nor columns are never added or deleted but creation, i.e. neither rows nor columns are ever added or deleted.
that you do need to implement them if they are called, i.e. if your
Also note that you do need to implement them if they are called, i.e. if your
code either calls them directly or uses the matching wxGrid methods, as code either calls them directly or uses the matching wxGrid methods, as
by default they simply do nothing which is definitely inappropriate. by default they simply do nothing which is definitely inappropriate.
*/ */
@@ -1599,7 +1600,7 @@ public:
//@} //@}
/** /*!
@name Table Row and Column Labels @name Table Row and Column Labels
By default the numbers are used for labeling rows and Latin letters for By default the numbers are used for labeling rows and Latin letters for
@@ -2383,7 +2384,7 @@ public:
//@} //@}
/** /*!
@name Cell Formatting @name Cell Formatting
Note that wxGridCellAttr can be used alternatively to most of these Note that wxGridCellAttr can be used alternatively to most of these
@@ -2519,7 +2520,7 @@ public:
//@} //@}
/** /*!
@name Cell Values, Editors, and Renderers @name Cell Values, Editors, and Renderers
Note that wxGridCellAttr can be used alternatively to most of these Note that wxGridCellAttr can be used alternatively to most of these