some more work on doxygen generation for the framework

w3c · May 3, 2024 · ca2be0c · ca2be0c
1 parent 81551e2
commit ca2be0c
Show file tree

Hide file tree

Showing 12 changed files with 46 additions and 10 deletions.
diff --git a/source/docs/Doxyfile.in → source/docs/framework-doxyfile.in b/source/docs/Doxyfile.in → source/docs/framework-doxyfile.in
@@ -10,5 +10,8 @@
 # [1] https://www.w3.org/Consortium/Legal/copyright-software
 #
 
+PROJECT_NAME           = "W3C IPA Framework"
 OUTPUT_DIRECTORY       = @CMAKE_CURRENT_BINARY_DIR@/doc_doxygen/
 INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/src/ @CMAKE_CURRENT_SOURCE_DIR@/include/
+RECURSIVE              = YES
+FILE_PATTERNS          = *.cpp *.h
diff --git a/source/w3cipa/w3cipaframework/CMakeLists.txt b/source/w3cipa/w3cipaframework/CMakeLists.txt
@@ -103,7 +103,7 @@ if (CMAKE_BUILD_TYPE MATCHES "^[Rr]elease")
     find_package(Doxygen)
     if (DOXYGEN_FOUND)
         # set input and output files
-        set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/../../docs/Doxyfile.in)
+        set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/../../docs/framework-doxyfile.in)
         set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
 
         # request to configure the file

diff --git a/source/w3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/ClientRequest.h b/source/w3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/ClientRequest.h
@@ -33,7 +33,11 @@ class ClientRequest : public IPAData {
 public:
     /**
      * Constructs a new object.
+     * @param sessionIdentifier the session identifier
+     * @param requestIdentifier the request identifier
      * @param multiModalInputs The multimodal inputs to be sent to the client.
+     * @param audioDataToSend audio data to send
+     * @param metaDataToSend meta data to send
      */
     ClientRequest(const std::shared_ptr<SessionId>& sessionIdentifier,
                   const std::shared_ptr<RequestId>& requestIdentifier,

diff --git a/source/w3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/ClientResponse.h b/source/w3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/ClientResponse.h
@@ -33,7 +33,12 @@ class ClientResponse : public IPAData {
 public:
     /**
      * Constructs a new object.
-     * @param multiModalOutputs The multimodal outputs to be returned to the client.
+     * @param sessionIdentifier the session identifier
+     * @param requestIdentifier the request identifier
+     * @param multiModalOutputs The multimodal outputs to be returned to the
+     *          client.
+     * @param audioDataToSend audio data to send
+     * @param metaDataToSend meta data to send
      */
     ClientResponse(const std::shared_ptr<SessionId>& sessionIdentifier,
                    const std::shared_ptr<RequestId>& requestIdentifier,

diff --git a/source/w3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/CombinedId.h b/source/w3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/CombinedId.h
@@ -41,7 +41,7 @@ class CombinedId {
 
     /**
      * Creates a new object as a copy of the provided object.
-     * @param other the object to copy from
+     * @param id the object to copy from
      */
     CombinedId(const CombinedId& id);
 

diff --git a/source/w3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/IPADataProcessor.h b/source/w3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/IPADataProcessor.h
@@ -61,6 +61,10 @@ class IPADataProcessor {
     void addIPADataProcessorListener(
             const std::shared_ptr<IPADataProcessor>& listener);
 
+    /**
+     * Shortcut for {@link addIPADataProcessorListener(const std::shared_ptr<IPADataProcessor>& listener)}.
+     * @param other the listener to add
+     */
     void operator >>(const std::shared_ptr<IPADataProcessor>& other);
 protected:
     /**

diff --git a/source/w3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/MetaData.h b/source/w3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/MetaData.h
@@ -20,7 +20,7 @@ namespace voiceinteraction {
 namespace ipa {
 
 /**
- * Interfacce for meta data of {@llink w3c::voiceinteraction::ClientRequest}.
+ * Interfacce for meta data of {@link w3c::voiceinteraction::ClientRequest}.
  * @author Dirk Schnelle-Walka
  */
 class MetaData

diff --git a/source/w3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/TextModalityType.h b/source/w3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/TextModalityType.h
@@ -26,7 +26,15 @@ namespace ipa {
 class TextModalityType : public ModalityType
 {
 public:
+    /**
+     * Constructs a new object.
+     */
     TextModalityType();
+
+    /**
+     * Copy constructor.
+     * @param other the object to copy from
+     */
     TextModalityType(const TextModalityType& other);
 };
 

diff --git a/source/w3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/VoiceModalityType.h b/source/w3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/VoiceModalityType.h
@@ -26,7 +26,15 @@ namespace ipa {
 class VoiceModalityType : public ModalityType
 {
 public:
+    /**
+     * Constructs a new object.
+     */
     VoiceModalityType();
+
+    /**
+     * Copy constructor.
+     * @param other the object to copy from
+     */
     VoiceModalityType(const VoiceModalityType& other);
 };
 

diff --git a/...e/w3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/client/InputModalityComponent.h b/...e/w3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/client/InputModalityComponent.h
@@ -26,7 +26,7 @@ namespace client {
  * A component to hand mutlimodal inputs.
  *
  * Input modality components are also asked to inherit from
- * {@link ModalityComponent} and support {@link IOType::INPUT}.
+ * {@link ModalityComponent} and support {@link IOType#INPUT}.
  * @author Dirk Schnelle-Walka
  */
 class InputModalityComponent {
@@ -44,7 +44,7 @@ class InputModalityComponent {
     /**
      * Starts listening asynchronously for inputs and notify the provided
      * medaitor if any input is received from this component.
-     * @param the mediator to handle input notifications.
+     * @param mediator the mediator to handle input notifications.
      */
     virtual void startInput(
         const std::shared_ptr<InputNotificationMediator>& mediator) = 0;

diff --git a/...3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/client/InputNotificationMediator.h b/...3cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/client/InputNotificationMediator.h
@@ -23,8 +23,12 @@ namespace voiceinteraction {
 namespace ipa {
 namespace client {
 
-class InputNotificationMediator
-{
+/**
+ * A mediator knowing all listeners for MultiModalInput to arrive.
+ *
+ * @author Dirk Schnelle-Walka
+ */
+class InputNotificationMediator {
 public:
     /**
      * Constructs a new object.

diff --git a/...cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/external/ProviderSelectionService.h b/...cipa/w3cipaframework/include/w3c/voiceinteraction/ipa/external/ProviderSelectionService.h
@@ -49,10 +49,10 @@ class ProviderSelectionService : public IPADataProcessor {
 
     /**
      * Processes the input and forwards it to the relevant IPA providers.
-     * @param request incoming request.
+     * @param data incoming data.
      * @return list of responses from the IPA providers
      */
-    void processIPAData(std::shared_ptr<IPAData> data);
+    void processIPAData(std::shared_ptr<IPAData> data) override;
 
 protected:
     /** The provider registry. */