Add 'cowl_ontology_header_empty' and missing CowlOntologyHeader docs

sisinflab-swot · Feb 28, 2024 · 9bf074e · 9bf074e
1 parent 1e9470f
commit 9bf074e
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/docs/api/crud/write.rst b/docs/api/crud/write.rst
@@ -43,6 +43,9 @@ ontology document must be serialized via the :struct:`CowlOStream` API. Similarl
 you can retrieve a :struct:`CowlOStream` instance via :func:`cowl_manager_get_ostream()`.
 
 .. doxygenstruct:: CowlStreamWriter
+.. doxygenstruct:: CowlOntologyHeader
+.. doxygengroup:: CowlOntologyHeader
+   :content-only:
 .. doxygenstruct:: CowlOStream
 .. doxygengroup:: CowlOStream
    :content-only:
diff --git a/include/cowl_ontology_header.h b/include/cowl_ontology_header.h
@@ -32,6 +32,25 @@ typedef struct CowlOntologyHeader {
 
 } CowlOntologyHeader;
 
+/**
+ * @defgroup CowlOntologyHeader CowlOntologyHeader API
+ * @{
+ */
+
+/**
+ * Returns an empty ontology header.
+ *
+ * @return Empty ontology header.
+ */
+COWL_CONST
+COWL_INLINE
+CowlOntologyHeader cowl_ontology_header_empty(void) {
+    CowlOntologyHeader header = { cowl_ontology_id_anonymous(), NULL, NULL };
+    return header;
+}
+
+/// @}
+
 COWL_END_DECLS
 
 #endif // COWL_ONTOLOGY_HEADER_H