[gnome-builder] doc: add docs for build identifier



commit 2b238cf618a28519422f6b44025779c90ee1a711
Author: Christian Hergert <chergert redhat com>
Date:   Sat Nov 4 17:49:16 2017 -0700

    doc: add docs for build identifier

 src/libide/ide-build-ident.h.in |   20 ++++++++++++++++----
 1 files changed, 16 insertions(+), 4 deletions(-)
---
diff --git a/src/libide/ide-build-ident.h.in b/src/libide/ide-build-ident.h.in
index ea3ca17..51f0266 100644
--- a/src/libide/ide-build-ident.h.in
+++ b/src/libide/ide-build-ident.h.in
@@ -16,15 +16,27 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef IDE_BUILD_IDENT_H
-#define IDE_BUILD_IDENT_H
+#pragma once
 
 #include <glib.h>
 
 G_BEGIN_DECLS
 
+/**
+ * SECTION:ide-build-ident
+ * @title: Build Identifier
+ * @short_description: Identify a build by unique build identifier
+ *
+ * Since: 3.22
+ */
+
+/**
+ * IDE_BUILD_IDENTIFIER:
+ *
+ * A string containing a tag that defines the version of Builder that
+ * was built. Generally, this will be a small version tag plus some
+ * information to identify the git commit hash when applicable.
+ */
 #define IDE_BUILD_IDENTIFIER "@VCS_TAG@"
 
 G_END_DECLS
-
-#endif /* IDE_BUILD_IDENT_H */


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]