Complete core documentation (#150)

docs/Doxyfile

@@ -190,7 +190,7 @@ FULL_PATH_NAMES        = YES
 # will be relative from the directory where doxygen is started.
 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
 
-STRIP_FROM_PATH        =
+STRIP_FROM_PATH        = ../
 
 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
 # path mentioned in the documentation of a class, which tells the reader which
@@ -907,7 +907,7 @@ WARN_IF_UNDOC_ENUM_VAL = NO
 # Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.
 # The default value is: NO.
 
-WARN_AS_ERROR          = NO
+WARN_AS_ERROR          = YES
 
 # The WARN_FORMAT tag determines the format of the warning messages that doxygen
 # can produce. The string should contain the $file, $line, and $text tags, which

src/core/map.cpp

@@ -1615,6 +1615,8 @@ void Map::setConnectionEstablished() {
     have changed. This can be caused by a style change or adding a new source.
 */
 
+/*! \cond PRIVATE */
+
 MapPrivate::MapPrivate(Map *map, const Settings &settings, const QSize &size, qreal pixelRatio_)
     : QObject(map),
       m_mode(settings.contextMode()),
@@ -1782,4 +1784,6 @@ bool MapPrivate::setProperty(const PropertySetter &setter,
     return true;
 }
 
+/*! \endcond */
+
 } // namespace QMapLibre

src/core/map_observer.cpp

@@ -13,6 +13,8 @@
 
 namespace QMapLibre {
 
+/*! \cond PRIVATE */
+
 MapObserver::MapObserver(MapPrivate *ptr)
     : d_ptrRef(ptr) {}
 
@@ -110,4 +112,6 @@ void MapObserver::onSourceChanged(mbgl::style::Source & /* source */) {
     emit mapChanged(Map::MapChangeSourceDidChange);
 }
 
+/*! \endcond */
+
 } // namespace QMapLibre

src/core/map_renderer.cpp

@@ -37,6 +37,8 @@ auto *getScheduler() {
 
 namespace QMapLibre {
 
+/*! \cond PRIVATE */
+
 MapRenderer::MapRenderer(qreal pixelRatio, Settings::GLContextMode mode, const QString &localFontFamily)
     : m_backend(static_cast<mbgl::gfx::ContextMode>(mode)),
       m_renderer(std::make_unique<mbgl::Renderer>(
@@ -103,4 +105,6 @@ void MapRenderer::setObserver(mbgl::RendererObserver *observer) {
     m_renderer->setObserver(observer);
 }
 
+/*! \endcond */
+
 } // namespace QMapLibre

src/core/settings.cpp

@@ -631,6 +631,8 @@ const mbgl::TileServerOptions &Settings::tileServerOptions() const {
     return d_ptr->m_tileServerOptions;
 }
 
+/*! \cond PRIVATE */
+
 // Private implementation
 SettingsPrivate::SettingsPrivate()
     : m_cacheMaximumSize(mbgl::util::DEFAULT_MAX_CACHE_SIZE),
@@ -665,4 +667,6 @@ void SettingsPrivate::setProviderApiBaseUrl(const QString &url) {
     m_tileServerOptions = std::move(m_tileServerOptions.withBaseURL(url.toStdString()));
 }
 
+/*! \endcond */
+
 } // namespace QMapLibre

src/core/style/image_style_change.cpp

@@ -8,6 +8,8 @@
 
 namespace QMapLibre {
 
+/*! \cond PRIVATE */
+
 // StyleAddImage
 StyleAddImage::StyleAddImage(const StyleParameter *parameter)
     : m_id(parameter->property("id").toString()),
@@ -36,4 +38,6 @@ void StyleRemoveImage::apply(Map *map) {
     map->removeImage(m_id);
 }
 
+/*! \endcond */
+
 } // namespace QMapLibre

src/core/style/layer_style_change.cpp

@@ -11,6 +11,8 @@
 
 namespace QMapLibre {
 
+/*! \cond PRIVATE */
+
 // StyleAddLayer
 StyleAddLayer::StyleAddLayer(const Feature &feature, const std::vector<FeatureProperty> &properties, QString before)
     : m_id(feature.id.toString()),
@@ -154,4 +156,6 @@ void StyleSetFilter::apply(Map *map) {
     map->setFilter(m_layerId, m_expression);
 }
 
+/*! \endcond */
+
 } // namespace QMapLibre

src/core/style/source_style_change.cpp

@@ -13,6 +13,8 @@
 
 namespace QMapLibre {
 
+/*! \cond PRIVATE */
+
 // StyleAddSource
 StyleAddSource::StyleAddSource(const Feature &feature)
     : m_id(feature.id.toString()) {
@@ -94,4 +96,6 @@ void StyleRemoveSource::apply(Map *map) {
     map->removeSource(m_id);
 }
 
+/*! \endcond */
+
 } // namespace QMapLibre

src/core/style/style_change.cpp

@@ -8,6 +8,8 @@
 
 #include <QMapLibre/Map>
 
+/*! \cond PRIVATE */
+
 namespace QMapLibre {
 
 // StyleChange
@@ -68,4 +70,6 @@ std::vector<std::unique_ptr<StyleChange>> StyleChange::removeParameter(const Sty
     return changes;
 }
 
+/*! \endcond */
+
 } // namespace QMapLibre

src/core/style/style_change_utils.cpp

@@ -7,6 +7,8 @@
 #include <QtCore/QMetaProperty>
 #include <QtCore/QRegularExpression>
 
+/*! \cond PRIVATE */
+
 namespace QMapLibre::StyleChangeUtils {
 
 QList<QByteArray> allPropertyNamesList(const QObject *object) {
@@ -29,3 +31,5 @@ QByteArray formatPropertyName(const QByteArray &name) {
 }
 
 } // namespace QMapLibre::StyleChangeUtils
+
+/*! \endcond */