From 8956c5623536f196eff9e7f369e3176dde6b7c04 Mon Sep 17 00:00:00 2001 From: Pieter Hijma Date: Thu, 10 Apr 2025 17:09:03 +0200 Subject: [PATCH] [Doc] Add documentation top-level namespace App --- src/App/ExpressionParser.h | 6 ++++++ src/App/Metadata.h | 6 ++++++ src/App/ProgramOptionsUtilities.h | 6 ++++++ 3 files changed, 18 insertions(+) diff --git a/src/App/ExpressionParser.h b/src/App/ExpressionParser.h index f9b8b7d8d5..9935167fbb 100644 --- a/src/App/ExpressionParser.h +++ b/src/App/ExpressionParser.h @@ -594,6 +594,12 @@ protected: std::string end; }; +/** + * Namespace for parsing expressions. + * + * Contains functionality for parsing expressions, the units of + * expressions, whether a token is an identifier, unit, or constant. + */ namespace ExpressionParser { AppExport Expression* parse(const App::DocumentObject* owner, const char* buffer); diff --git a/src/App/Metadata.h b/src/App/Metadata.h index 271a112483..200c811af2 100644 --- a/src/App/Metadata.h +++ b/src/App/Metadata.h @@ -39,6 +39,12 @@ namespace App { +/** + * A namespace for metadata for Python external addons. + * + * This namespace contains functionality to define the contents of a + * package.xml file, such as Contact, License, Url, and Dependency. + */ namespace Meta { diff --git a/src/App/ProgramOptionsUtilities.h b/src/App/ProgramOptionsUtilities.h index 5a511b0adc..8ddac75f99 100644 --- a/src/App/ProgramOptionsUtilities.h +++ b/src/App/ProgramOptionsUtilities.h @@ -28,6 +28,12 @@ #include #include +/** + * A namespace for utilities. + * + * Currently, this namespace contains functionality to define custom syntax to + * parse command line options. + */ namespace App::Util {