Skip to content

Commit 8738d2e

Browse files
author
Michael Tims
authored
Merge pull request #296 from Esri/tdunn/20180626-api-doc
Fix some API doc build warnings
2 parents fb6d554 + 78e7973 commit 8738d2e

File tree

7 files changed

+64
-30
lines changed

7 files changed

+64
-30
lines changed

‎Import/Esri/ArcGISRuntime/Toolkit/Controls/CppApi/CoordinateConversion.qml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Item {
9797
\li \c UTM.
9898
\li \c GARS
9999
\li GeoRef
100-
\endList
100+
\endlist
101101
*/
102102
property alias inputFormat: coordinateConvController.inputFormat
103103

‎Import/Esri/ArcGISRuntime/Toolkit/Controls/CppApi/TimeSlider.qml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Item {
140140
141141
The default is \c Qt.DefaultLocaleShortDate.
142142
143-
\sa \l Qt.formatDateTime
143+
\sa Qt.formatDateTime
144144
*/
145145
property var fullExtentLabelFormat
146146

@@ -159,7 +159,7 @@ Item {
159159
160160
The default is \c Qt.DefaultLocaleShortDate.
161161
162-
\sa \l Qt.formatDateTime
162+
\sa Qt.formatDateTime
163163
*/
164164
property var currentExtentLabelFormat
165165

@@ -197,7 +197,7 @@ Item {
197197
\li labelModeNone. No labels are applied
198198
\li labelModeThumbs. Labels are applied to the slider thumbs.
199199
\li labelModeTicks. Labels are applied to the slider tick marks.
200-
\endList
200+
\endlist
201201
202202
The default is \c labelModeThumbs.
203203
*/
@@ -266,7 +266,7 @@ Item {
266266
267267
The default is \c Qt.DefaultLocaleShortDate.
268268
269-
\sa \l Qt.formatDateTime
269+
\sa Qt.formatDateTime
270270
*/
271271
property var timeStepIntervalLabelFormat
272272

‎Import/Esri/ArcGISRuntime/Toolkit/Controls/QmlApi/TimeSlider.qml‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -129,12 +129,12 @@ Item {
129129

130130
/*!
131131
\qmlproperty var fullExtentLabelFormat
132-
\brief The format for displaying \l Date values
133-
for the full time extent. - for example "yy/MM/dd".
132+
\brief The format for displaying Date values
133+
for the full time extent, for example "yy/MM/dd".
134134
135135
The default is \c Qt.DefaultLocaleShortDate.
136136
137-
\sa \l Qt.formatDateTime
137+
\sa Qt.formatDateTime
138138
*/
139139
property var fullExtentLabelFormat
140140

@@ -148,12 +148,12 @@ Item {
148148

149149
/*!
150150
\qmlproperty var currentExtentLabelFormat
151-
\brief The format for displaying \l Date values
151+
\brief The format for displaying Date values
152152
for the current time extent. - for example "yy/MM/dd".
153153
154154
The default is \c Qt.DefaultLocaleShortDate.
155155
156-
\sa \l Qt.formatDateTime
156+
\sa Qt.formatDateTime
157157
*/
158158
property var currentExtentLabelFormat
159159

@@ -188,10 +188,10 @@ Item {
188188
189189
Valid options are:
190190
\list
191-
\li labelModeNone. No labels are applied
192-
\li labelModeThumbs. Labels are applied to the slider thumbs.
193-
\li labelModeTicks. Labels are applied to the slider tick marks.
194-
\endList
191+
\li labelModeNone - No labels are applied
192+
\li labelModeThumbs - Labels are applied to the slider thumbs.
193+
\li labelModeTicks - Labels are applied to the slider tick marks.
194+
\endlist
195195
196196
The default is \c labelModeThumbs.
197197
*/
@@ -260,7 +260,7 @@ Item {
260260
261261
The default is \c Qt.DefaultLocaleShortDate.
262262
263-
\sa \l Qt.formatDateTime
263+
\sa Qt.formatDateTime
264264
*/
265265
property var timeStepIntervalLabelFormat
266266

‎Import/Esri/ArcGISRuntime/Toolkit/Controls/QmlApi/TimeSliderController.qml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,10 +202,12 @@ Item {
202202
handleTimeAwareLayers();
203203
}
204204

205+
/*! \internal */
205206
function validLayer(layer) {
206207
return layer && layer.visible && layer.timeFilteringEnabled;
207208
}
208209

210+
/*! \internal */
209211
function handleTimeAwareLayers() {
210212
timeStepInterval = null;
211213
for (var i = 0 ; i < timeAwareLayers.length; i++) {
@@ -237,13 +239,15 @@ Item {
237239
setStepTimes();
238240
}
239241

242+
/*! \internal */
240243
function isGreaterThan(timeValue, otherTimeValue) {
241244
if (timeValue.unit === otherTimeValue.unit)
242245
return timeValue.duration > otherTimeValue.duration;
243246
else
244247
return toMilliseconds(timeValue) > toMilliseconds(otherTimeValue);
245248
}
246249

250+
/*! \internal */
247251
function toMilliseconds(timeValue) {
248252
switch (timeValue.unit)
249253
{
@@ -272,6 +276,7 @@ Item {
272276
}
273277
}
274278

279+
/*! \internal */
275280
function union(timeExtent, otherTimeExtent) {
276281
if (otherTimeExtent === null)
277282
return timeExtent;
@@ -284,6 +289,7 @@ Item {
284289
return ArcGISRuntimeEnvironment.createObject("TimeExtent", properties);
285290
}
286291

292+
/*! \internal */
287293
function calculateNumberOfSteps(timeExtent, timeValue) {
288294
if (!timeExtent)
289295
return;
@@ -297,6 +303,7 @@ Item {
297303
numberOfSteps = (range / intervalMS) + 1;
298304
}
299305

306+
/*! \internal */
300307
function setStepTimes() {
301308
var tempStepTimes = [];
302309

@@ -307,6 +314,7 @@ Item {
307314
stepTimes = tempStepTimes;
308315
}
309316

317+
/*! \internal */
310318
function toTimeUnit() {
311319
var daysPerYear = 365.0;
312320
var millisecondsPerDay = 86400000.0;

‎Plugin/CppApi/include/AbstractTool.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ class TOOLKIT_EXPORT AbstractTool : public QObject
3838
{
3939
Q_OBJECT
4040

41+
/*! \internal */
4142
Q_PROPERTY(bool active READ isActive WRITE setActive NOTIFY activeChanged)
4243

4344
public:

‎Plugin/CppApi/include/CoordinateConversion/CoordinateConversionController.h‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,11 @@ class TOOLKIT_EXPORT CoordinateConversionController : public AbstractTool
5858
Q_PROPERTY(bool runConversion READ runConversion WRITE setRunConversion NOTIFY runConversionChanged)
5959

6060
// set the input format etc.
61+
/*! \internal */
6162
Q_PROPERTY(QString inputFormat READ inputFormat WRITE setInputFormat NOTIFY inputFormatChanged)
63+
/*! \internal */
6264
Q_PROPERTY(QStringList coordinateFormats READ coordinateFormats NOTIFY coordinateFormatsChanged)
65+
/*! \internal */
6366
Q_PROPERTY(QString pointToConvert READ pointToConvert NOTIFY pointToConvertChanged)
6467

6568
// whether the tool is in "capture mode" (sets the target to a clicked point) or "live" mode (uses current location)
@@ -96,6 +99,7 @@ class TOOLKIT_EXPORT CoordinateConversionController : public AbstractTool
9699
signals:
97100
void optionsChanged();
98101
void resultsChanged();
102+
/*! \internal */
99103
void inputModeChanged();
100104
void runConversionChanged();
101105
void pointToConvertChanged();

‎Plugin/CppApi/source/CoordinateConversion/CoordinateConversionController.cpp‎

Lines changed: 36 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -383,8 +383,10 @@ bool CoordinateConversionController::isCaptureMode() const
383383
/*!
384384
\brief Sets the tool's capture mode to \a captureMode.
385385
386-
If \c true, the tool will convert a point set via a mouse click.
387-
If \c false, the too will use the app's current location as the target point.
386+
\list
387+
\li \c true = convert a point set via a mouse click.
388+
\li \c false = use the app's current location as the target point.
389+
\endlist
388390
*/
389391
void CoordinateConversionController::setCaptureMode(bool captureMode)
390392
{
@@ -399,9 +401,11 @@ void CoordinateConversionController::setCaptureMode(bool captureMode)
399401
}
400402

401403
/*!
404+
\fn void CoordinateConversionController::onMouseClicked(QMouseEvent& mouseEvent);
402405
\brief Handles the mouse click at \a mouseEvent .
403406
404-
If the tool is active and in \l captureMode, this will be used as the input for conversions.
407+
If the tool is active and is in \l captureMode, the clicked location will be used
408+
as the input for conversions.
405409
*/
406410
void CoordinateConversionController::onMouseClicked(QMouseEvent& mouseEvent )
407411
{
@@ -415,9 +419,11 @@ void CoordinateConversionController::onMouseClicked(QMouseEvent& mouseEvent )
415419
}
416420

417421
/*!
422+
\fn void CoordinateConversionController::onLocationChanged(const Point& location);
418423
\brief Handles the app's location update to \a location.
419424
420-
If the tool is active and is not in \l captureMode, this will be used as the input for conversions.
425+
If the tool is active and is not in \l captureMode, the location will be used
426+
as the input for conversions.
421427
*/
422428
void CoordinateConversionController::onLocationChanged(const Point& location)
423429
{
@@ -495,13 +501,14 @@ QString CoordinateConversionController::toolName() const
495501
return "CoordinateConversion";
496502
}
497503

498-
/*! \brief Sets any values in \a properties which are relevant for the coordinate conversion controller.
499-
*
500-
* This tool will use the following key/value pairs in the \a properties map if they are set:
501-
*
502-
* \list
503-
* \li CoordinateFormat. The default input coordinate format for the tool.
504-
* \endList
504+
/*!
505+
\brief Sets any values in \a properties which are relevant for the coordinate conversion controller.
506+
507+
This tool will use the following key/value pairs in the \a properties map if they are set:
508+
509+
\list
510+
\li CoordinateFormat. The default input coordinate format for the tool.
511+
\endlist
505512
*/
506513
void CoordinateConversionController::setProperties(const QVariantMap& properties)
507514
{
@@ -511,7 +518,7 @@ void CoordinateConversionController::setProperties(const QVariantMap& properties
511518
}
512519

513520
/*!
514-
* \brief Returns a string representation of the input point in the input coordinate format.
521+
\brief Returns a string representation of the input point in the input coordinate format.
515522
*/
516523
QString CoordinateConversionController::pointToConvert() const
517524
{
@@ -605,9 +612,11 @@ void CoordinateConversionController::removeCoordinateFormat(const QString& forma
605612
}
606613

607614
/*!
608-
\brief Returns the screen coordinate of the current \l pointToConvert, within the bounds of \a screenWidth and \a screenHeight.
615+
\brief Returns the screen coordinate of the current \l pointToConvert,
616+
within the bounds of \a screenWidth and \a screenHeight.
609617
610-
If the point is off the screen, attempts to find the closest point on the screen (e.g. on the edge) to the point.
618+
If the point is off the screen, attempts to find the closest point on the
619+
screen (e.g. on the edge) to the point.
611620
*/
612621
QPointF CoordinateConversionController::screenCoordinate() const
613622
{
@@ -734,11 +743,23 @@ void CoordinateConversionController::setRunConversion(bool runConversion)
734743
emit runConversionChanged();
735744
}
736745

746+
// properties
747+
748+
/*!
749+
\qmlproperty bool CoordinateConversionController::captureMode
750+
\brief The tool's capture mode.
751+
\list
752+
\li \c true = convert a point set via a mouse click.
753+
\li \c false = use the app's current location as the target point.
754+
\endlist
755+
*/
756+
737757
// signals
738758

739759
/*!
740760
\fn void CoordinateConversionController::optionsChanged();
741-
\brief Signal emitted when the \l options property changes.
761+
\brief Signal emitted when options are added, cleared, or when a coordinate
762+
format is removed.
742763
*/
743764

744765
/*!

0 commit comments

Comments
 (0)