Merge pull request #6593 from shachar-a/doc_warnings

Fix outdated documentation and missing flags

libs/full/components_base/include/hpx/components_base/server/migration_support.hpp

@@ -27,6 +27,7 @@
 
 namespace hpx::components {
 
+    /// \cond NOINTERNAL
     namespace detail {
 
         template <typename Mutex>

libs/full/runtime_components/include/hpx/runtime_components/component_registry.hpp

@@ -68,17 +68,7 @@ namespace hpx::components {
             return true;
         }
 
-        /// \brief Return the unique identifier of the component type this
-        ///        factory is responsible for
-        ///
-        /// \param locality     [in] The id of the locality this factory
-        ///                     is responsible for.
-        /// \param agas_client  [in] The AGAS client to use for component id
-        ///                     registration (if needed).
-        ///
-        /// \return Returns the unique identifier of the component type this
-        ///         factory instance is responsible for. This function throws
-        ///         on any error.
+        /// \brief Enables this type of registry and sets its destroy mechanism
         void register_component_type() override
         {
             using type_holder = typename Component::type_holder;

libs/full/runtime_distributed/include/hpx/runtime_distributed.hpp

@@ -48,8 +48,11 @@ namespace hpx {
     public:
         /// Construct a new HPX runtime instance
         ///
-        /// \param locality_mode  [in] This is the mode the given runtime
-        ///                       instance should be executed in.
+        /// \param rtcfg        Runtime configuration for this instance
+        /// \param pre_main     Function to be called before running the
+        ///                     main action of this instance
+        /// \param post_main    Function to be called after running the
+        ///                     main action of this instance
         explicit runtime_distributed(util::runtime_configuration& rtcfg,
             int (*pre_main)(runtime_mode) = nullptr,
             void (*post_main)() = nullptr);
@@ -122,6 +125,9 @@ namespace hpx {
         ///                   return immediately. Use a second call to stop
         ///                   with this parameter set to \a true to wait for
         ///                   all internal work to be completed.
+        /// \param cond       Condition used to update all thread when done
+        /// \param mtx        Mutex used by this function to sync all threads
+
         void stop_helper(
             bool blocking, std::condition_variable& cond, std::mutex& mtx);
 

libs/full/runtime_distributed/include/hpx/runtime_distributed/runtime_fwd.hpp

@@ -38,6 +38,7 @@ namespace hpx {
     namespace util {
         struct binary_filter;
     }    // namespace util
+    /// \endcond
 
     ///////////////////////////////////////////////////////////////////////////
     /// \brief Start all active performance counters, optionally naming the

libs/full/runtime_distributed/include/hpx/runtime_distributed/server/runtime_support.hpp

@@ -99,10 +99,6 @@ namespace hpx::components::server {
 
         /// \brief finalize() will be called just before the instance gets
         ///        destructed
-        ///
-        /// \param self [in] The HPX \a thread used to execute this function.
-        /// \param appl [in] The applier to be used for finalization of the
-        ///             component instance.
         static constexpr void finalize() {}
 
         void delete_function_lists();