Browse Source

[master] Added (fixed) src/bin/agent to Doxyfile

Francis Dupont 8 years ago
parent
commit
c5ceebc63c
3 changed files with 19 additions and 16 deletions
  1. 2 1
      doc/Doxyfile
  2. 11 9
      src/bin/agent/ca_response_creator.h
  3. 6 6
      src/bin/agent/ca_response_creator_factory.h

+ 2 - 1
doc/Doxyfile

@@ -771,7 +771,8 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../src/bin/d2 \
+INPUT                  = ../src/bin/agent \
+                         ../src/bin/d2 \
                          ../src/bin/dhcp4 \
                          ../src/bin/dhcp6 \
                          ../src/bin/perfdhcp \

+ 11 - 9
src/bin/agent/ca_response_creator.h

@@ -22,13 +22,13 @@ typedef boost::shared_ptr<CtrlAgentResponseCreator> CtrlAgentResponseCreatorPtr;
 /// @brief Concrete implementation of the HTTP response crator used
 /// by the Control Agent.
 ///
-/// See the documentation of the @ref HttpResponseCreator for the basic
-/// information how HTTP response creators are utilized by the libkea-http
-/// library to generate HTTP responses.
+/// See the documentation of the @ref isc::http::HttpResponseCreator for
+/// the basic information how HTTP response creators are utilized by
+/// the libkea-http library to generate HTTP responses.
 ///
 /// This creator expects that received requests are encapsulated in the
-/// @ref PostHttpRequestJson objects. The generated responses are
-/// encapsulated in the HttpResponseJson objects.
+/// @ref isc::http::PostHttpRequestJson objects. The generated responses
+/// are encapsulated in the HttpResponseJson objects.
 ///
 /// This class uses @ref CtrlAgentCommandMgr singleton to process commands
 /// conveyed in the HTTP body. The JSON responses returned by the manager
@@ -38,17 +38,19 @@ public:
 
     /// @brief Create a new request.
     ///
-    /// This method creates a bare instance of the @ref PostHttpRequestJson.
+    /// This method creates a bare instance of the @ref
+    /// isc::http::PostHttpRequestJson.
     ///
-    /// @return Pointer to the new instance of the @ref PostHttpRequestJson.
+    /// @return Pointer to the new instance of the @ref
+    /// isc::http::PostHttpRequestJson.
     virtual http::HttpRequestPtr createNewHttpRequest() const;
 
     /// @brief Creates stock HTTP response.
     ///
     /// @param request Pointer to an object representing HTTP request.
     /// @param status_code Status code of the response.
-    /// @return Pointer to an @ref HttpResponseJson object representing stock
-    /// HTTP response.
+    /// @return Pointer to an @ref isc::http::HttpResponseJson object
+    /// representing stock HTTP response.
     virtual http::HttpResponsePtr
     createStockHttpResponse(const http::ConstHttpRequestPtr& request,
                             const http::HttpStatusCode& status_code) const;

+ 6 - 6
src/bin/agent/ca_response_creator_factory.h

@@ -15,14 +15,14 @@ namespace agent {
 
 /// @brief HTTP response creator factory for Control Agent.
 ///
-/// See the documentation of the @ref HttpResponseCreatorFactory for
-/// the details how the response factory object is used by the
-/// @ref HttpListener.
+/// See the documentation of the @ref isc::http::HttpResponseCreatorFactory
+/// for the details how the response factory object is used by the
+/// @ref isc::http::HttpListener.
 ///
 /// This class always returns the same instance of the
-/// @ref CtrlAgentResponseCreator which @ref HttpListener and
-/// @ref HttpConnection classes use to generate HTTP response messages
-/// which comply with the formats required by the Control Agent.
+/// @ref CtrlAgentResponseCreator which @ref isc::http::HttpListener and
+/// @ref isc::http::HttpConnection classes use to generate HTTP response
+/// messages which comply with the formats required by the Control Agent.
 class CtrlAgentResponseCreatorFactory : public http::HttpResponseCreatorFactory {
 public: