Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetics in doc generation
authorMartin Quinson <martin.quinson@loria.fr>
Mon, 6 Aug 2018 21:59:05 +0000 (23:59 +0200)
committerMartin Quinson <martin.quinson@loria.fr>
Mon, 6 Aug 2018 21:59:05 +0000 (23:59 +0200)
docs/source/conf.py
include/simgrid/s4u/Host.hpp
tools/cmake/Documentation.cmake

index e5bcf6c..562a77c 100644 (file)
@@ -60,8 +60,8 @@ exhale_args = {
     "createTreeView":        True,
     # TIP: if using the sphinx-bootstrap-theme, you need
     # "treeViewIsBootstrap": True,
-    "exhaleExecutesDoxygen": True,
-    "exhaleDoxygenStdin":    "INPUT = ../../include"
+    "exhaleExecutesDoxygen": False,
+    "exhaleDoxygenStdin":    "INPUT = ../../include"
 }
 
 # Add any paths that contain templates here, relative to this directory.
index 4098162..164da06 100644 (file)
@@ -95,6 +95,8 @@ public:
   const char* get_property(std::string key) const;
   void set_property(std::string key, std::string value);
   std::unordered_map<std::string, std::string>* get_properties();
+
+#ifndef DOXYGEN
   /** @deprecated See Host::get_properties() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_properties()") std::map<std::string, std::string>* getProperties()
   {
@@ -104,6 +106,7 @@ public:
       res->insert(kv);
     return res;
   }
+#endif
 
   double get_speed() const;
   double get_available_speed() const;
@@ -115,6 +118,7 @@ public:
   void set_pstate(int pstate_index);
   int get_pstate() const;
 
+#ifndef DOXYGEN
   /** @deprecated See Host::get_speed() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_speed() instead.") double getSpeed() { return get_speed(); }
   /** @deprecated See Host::get_pstate_speed() */
@@ -122,6 +126,7 @@ public:
   {
     return get_pstate_speed(pstate_index);
   }
+#endif
 
   std::vector<const char*> get_attached_storages() const;
   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_attached_storages() instead.") void getAttachedStorages(
@@ -151,6 +156,7 @@ public:
   void execute(double flops, double priority);
 
   // Deprecated functions
+#ifndef DOXYGEN
   /** @deprecated See Host::get_name() */
   XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_name()") simgrid::xbt::string const& getName() const
   {
@@ -203,6 +209,7 @@ public:
   {
     return get_pstate_count();
   }
+#endif /* !DOXYGEN */
 
 private:
   simgrid::xbt::string name_ {"noname"};
index 9efb344..cff5b2c 100644 (file)
@@ -24,6 +24,7 @@ if(enable_documentation)
     COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_BINARY_DIR}/doc/example_lists
     COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_BINARY_DIR}/doc/html
     COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_BINARY_DIR}/doc/html
+    COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_BINARY_DIR}/doc/xml
     WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
     )