From 85728cf0443286ae07059efa9af1d645b7ed5f8c Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Mon, 6 Aug 2018 23:59:05 +0200 Subject: [PATCH] cosmetics in doc generation --- docs/source/conf.py | 4 ++-- include/simgrid/s4u/Host.hpp | 7 +++++++ tools/cmake/Documentation.cmake | 1 + 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index e5bcf6c9b0..562a77c87f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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. diff --git a/include/simgrid/s4u/Host.hpp b/include/simgrid/s4u/Host.hpp index 4098162236..164da062a7 100644 --- a/include/simgrid/s4u/Host.hpp +++ b/include/simgrid/s4u/Host.hpp @@ -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* get_properties(); + +#ifndef DOXYGEN /** @deprecated See Host::get_properties() */ XBT_ATTRIB_DEPRECATED_v323("Please use Host::get_properties()") std::map* 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 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"}; diff --git a/tools/cmake/Documentation.cmake b/tools/cmake/Documentation.cmake index 9efb34430b..cff5b2c0f8 100644 --- a/tools/cmake/Documentation.cmake +++ b/tools/cmake/Documentation.cmake @@ -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 ) -- 2.20.1