updated doxygen

MasWag · Sep 10, 2019 · da09484 · da09484
1 parent f0894c5
commit da09484
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 7 deletions.
diff --git a/libmonaa/CMakeLists.txt b/libmonaa/CMakeLists.txt
@@ -1,5 +1,8 @@
 project(libmonaa)
 cmake_minimum_required(VERSION 3.1)
+set(VERSION_MAJOR 0)
+set(VERSION_MINOR 4)
+set(VERSION_PATCH 1)
 
 # add a target to generate API documentation with Doxygen
 find_package(Doxygen)
@@ -20,7 +23,4 @@ if(BUILD_DOCUMENTATION)
         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doc
         COMMENT "Generating API documentation with Doxygen"
         VERBATIM)
-
-## It does not install the document by default
-#    install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html DESTINATION share/doc)
 endif()
diff --git a/libmonaa/monaa.hh b/libmonaa/monaa.hh
@@ -1,18 +1,16 @@
 #pragma once
 /*! 
-  @file monaa.hh
-
   @mainpage Reference Manual of libmonaa
   
   This is the reference manual of libmonaa. For documentation on how to install libmonaa, see the <a href="https://github.com/MasWag/monaa/blob/master/libmonaa/README.md">README</a>.
 
   @section Overview
 
-  This library mainly provides the function @link monaa @endlink, which does do online timed pattern matching by the timed FJS algorithm, and as its parameters, the classes @link WordContainer @endlink, @link TimedAutomaton @endlink, and @link AnsContainer @endlink. The input and output container classes @link WordContainer @endlink and @link AnsContainer @endlink just define the interface of the container, and the classes passed by their template arguments defines the procedure. Therefore, users can define the functionality suitable for their application. For example, @link AnsContainer::push_back() @endlink can be used as a call back function when the procedure finds a matching in the input.
+  This library mainly provides the function @link monaaDollar @endlink, which does do online timed pattern matching by the timed FJS algorithm, and as its arguments, the classes @link WordContainer @endlink, @link TimedAutomaton @endlink, and @link AnsContainer @endlink. The input and output container classes @link WordContainer @endlink and @link AnsContainer @endlink just define the interface of the container, and the classes passed by their template arguments defines the procedure. Therefore, users can define the functionality suitable for their application. For example, @link AnsContainer::push_back() @endlink can be used as a call back function when the procedure finds a matching in the input.
 
   @note This document is not completed yet. The content may be changed later.
   @copyright (C) 2017 Masaki Waga. All rights reserved.
-*/ 
+*/
 
 #include <iostream>
 #include <chrono>
@@ -30,6 +28,18 @@
 #include "ans_vec.hh"
 
 #include "utils.hh"
+/*!
+  @file monaa.hh
+  @author Masaki Waga
+
+  @brief Functions for timed pattern matching
+
+  Currently, we have three functions: @link monaa @endlink, @link monaaDollar @endlink, and @link monaaNotNecessaryDollar @endlink. All of them looks very similar but they have some differences on the accepting conditions.
+  - @link monaaDollar @endlink: Same as our original paper [WHS17]. Namely, all the transitions to an accepting state must be labelled with '$' and we try to insert '$' between the given events.
+  - @link monaaNotNecessaryDollar @endlink: Similar to @link monaaDollar @endlink, but the transitions to the accepting state do not have to be labelled with '$'. The transitions to an accepting state but not labelled with '$' is used in the same way as the usual transitions.
+  - @link monaa @endlink: All the transitions cannot be labelled with '$'. For the transitions to an accepting state, we move the next event forward instead of inserting '$'. This looks like a monitoring of signals rather than timed words.
+ */
+
 
 // Internal state of BFS
 struct InternalState {