Skip to content

Commit 34c7eb4

Browse files
Merge pull request #426 from Esri/ldanzinger/doc_fix
fixing docs from doc build
2 parents 5013650 + 511d17c commit 34c7eb4

File tree

6 files changed

+26
-5
lines changed

6 files changed

+26
-5
lines changed

uitools/cpp/Esri/ArcGISRuntime/Toolkit/OverviewMapController.cpp

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,10 @@ namespace Toolkit {
192192
}
193193

194194
/*!
195-
\brief Sets the symbol used to represent the GeoView's current viewpoint.
195+
\brief Sets the \a symbol used to represent the GeoView's current viewpoint.
196+
197+
For MapView, the default is an empty SimpleFillSymbol with a 1 point red outline;
198+
for SceneView, it will be a red, cross-hair SimpleMarkerSymbol.
196199
*/
197200
void OverviewMapController::setSymbol(Symbol* symbol)
198201
{
@@ -220,6 +223,10 @@ namespace Toolkit {
220223

221224
/*!
222225
\brief Sets the amount to scale the OverviewMap compared to the geoView.
226+
227+
\list
228+
\li \a scaleFactor The scale factor. Defaults to 25.0.
229+
\endlist
223230
*/
224231
void OverviewMapController::setScaleFactor(double scaleFactor)
225232
{

uitools/cpp/Esri/ArcGISRuntime/Toolkit/PopupViewController.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -251,12 +251,12 @@ void PopupViewController::setAttachmentThumbnailHeight(int height)
251251
*/
252252

253253
/*!
254-
\fn void Esri::ArcGISRuntime::Toolkit::PopupViewController::attachmentWidthChanged()
254+
\fn void Esri::ArcGISRuntime::Toolkit::PopupViewController::attachmentThumbnailWidthChanged()
255255
\brief Signal emitted when the attachment minimum width changes.
256256
*/
257257

258258
/*!
259-
\fn void Esri::ArcGISRuntime::Toolkit::PopupViewController::attachmentHeightChanged()
259+
\fn void Esri::ArcGISRuntime::Toolkit::PopupViewController::attachmentThumbnailHeightChanged()
260260
\brief Signal emitted when the attachment minimum height changes.
261261
*/
262262

uitools/import/Esri/ArcGISRuntime/Toolkit/Controller/BasemapGalleryController.qml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,8 @@ QtObject {
100100
\brief Convenience function that appends a basemap to the gallery with an overloaded
101101
thumbnail and tooltip.
102102
103+
Returns whether the append was successful.
104+
103105
\list
104106
\li \a basemap Basemap to add to the gallery.
105107
\li \a thumbnailUrl Thumbnail to display in the gallery. Optional.

uitools/import/Esri/ArcGISRuntime/Toolkit/Controller/CurrentVersion.qml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
import QtQml 2.12
1818

19-
/*!
19+
/*
2020
\internal
2121
This QML file is only used for incrementing the current version of the toolkit and
2222
should not be used in your application.

uitools/register/Esri/ArcGISRuntime/Toolkit/register.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
*/
2727

2828
/*!
29-
\fn void Esri::ArcGISRuntime::Toolkit::registerComponents(QmlEngine&)
29+
\fn void Esri::ArcGISRuntime::Toolkit::registerComponents(QmlEngine& engine)
3030
\relates Esri/ArcGISRuntime/Toolkit/register
3131
\brief This registration function must be called after the QmlEngine has been
3232
declared, but before it is run. This sets up resources and component registration

uitools/widgets/Esri/ArcGISRuntime/Toolkit/Internal/UserCredentialView.cpp

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,21 @@ namespace Esri {
2323
namespace ArcGISRuntime {
2424
namespace Toolkit {
2525

26+
/*!
27+
\class Esri::ArcGISRuntime::Toolkit::UserCredentialView
28+
\inmodule EsriArcGISRuntimeToolkit
29+
\ingroup ArcGISQtToolkitUiCppWidgetsViews
30+
\brief The user interface for displaying a username/password sign-in dialog.
31+
32+
This will be used by the AuthenticationView for Token, HTTP Basic, HTTP Digest,
33+
and IWA logins.
34+
*/
35+
2636
/*!
37+
\fn UserCredentialView::UserCredentialView(AuthenticationController*, QWidget*)
2738
\brief Constructor.
2839
\list
40+
\li \a controller The authentication challenge controller.
2941
\li \a parent Parent widget.
3042
\endlist
3143
*/

0 commit comments

Comments
 (0)