Added initial Doxygen config

src/common/model/diagram.h

@@ -31,22 +31,49 @@ class diagram_filter;
 class element;
 class relationship;
 
+/**
+ * @brief Base class for all diagram models
+ *
+ * @embed{diagram_hierarchy_class.svg}
+ */
 class diagram {
 public:
     diagram();
 
     virtual ~diagram();
 
+    /**
+     * @brief Return type of the diagram.
+     *
+     * @return Type of diagram
+     */
     virtual diagram_t type() const = 0;
 
+    /**
+     * Return optional reference to a diagram_element by name.
+     *
+     * @param full_name Fully qualified name of a diagram element.
+     * @return Optional reference to a diagram element.
+     */
     virtual opt_ref<clanguml::common::model::diagram_element> get(
         const std::string &full_name) const = 0;
 
+    /**
+     * Return optional reference to a diagram_element by id.
+     *
+     * @param id Id of a diagram element.
+     * @return Optional reference to a diagram element.
+     */
     virtual common::optional_ref<clanguml::common::model::diagram_element> get(
         diagram_element::id_t id) const = 0;
 
-    /// \brief Find element in diagram which can have full name or be
-    ///        relative to ns
+    /**
+     * Return optional reference to a diagram_element by name and namespace.
+     *
+     * @param name Name of the diagram element (e.g. a class name)
+     * @param ns Namespace of the element.
+     * @return Optional reference to a diagram element.
+     */
     virtual common::optional_ref<clanguml::common::model::diagram_element>
     get_with_namespace(const std::string &name, const namespace_ &ns) const;
 
@@ -55,13 +82,52 @@ public:
     diagram &operator=(const diagram &) = delete;
     diagram &operator=(diagram && /*unused*/) noexcept;
 
+    /**
+     * Set diagram name.
+     *
+     * @param name Name of the diagram.
+     */
     void set_name(const std::string &name);
+
+    /**
+     * Return the name of the diagram.
+     *
+     * @return Name of the diagram.
+     */
     std::string name() const;
 
+    /**
+     * Set diagram filter for this diagram.
+     *
+     * @param filter diagram_filter instance
+     *
+     * @see clanguml::common::model::diagram_filter
+     */
     void set_filter(std::unique_ptr<diagram_filter> filter);
+
+    /**
+     * Get diagram filter
+     *
+     * @return Reference to the diagrams element filter
+     */
     const diagram_filter &filter() const { return *filter_; }
 
+    /**
+     * @brief Set diagram in a complete state.
+     *
+     * This must be called after the diagram's 'translation_unit_visitor' has
+     * completed for all translation units, in order to apply filters which can
+     * only work after the diagram is complete.
+     *
+     * @param complete Status of diagram visitor completion.
+     */
     void set_complete(bool complete);
+
+    /**
+     * Whether the diagram is complete.
+     *
+     * @return Diagram completion status.
+     */
     bool complete() const;
 
     // TODO: refactor to a template method
@@ -80,6 +146,11 @@ public:
     virtual bool should_include(
         const namespace_ &ns, const std::string &name) const;
 
+    /**
+     * Return diagrams JSON context for inja templates.
+     *
+     * @return JSON context.
+     */
     virtual inja::json context() const = 0;
 
 private: