Minor addition to docs

- flyby: cleanup index generation for startup functions - flyby: cleanup header docs for hpx_init and hpx_start
STEllAR-GROUP · Jun 4, 2017 · 3b3c56b · 3b3c56b
1 parent 48b891c
commit 3b3c56b
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 14 deletions.
diff --git a/docs/hpx.idx b/docs/hpx.idx
@@ -173,7 +173,7 @@ parallel::copy_if                     "copy_if" "hpx\.parallel\.v1\.copy_if.*"
 parallel::copy_n                      "copy_n" "hpx\.parallel\.v1\.copy_n.*"
 
 # hpx/parallel/algorithms/count.hpp
-parallel::count                       "count" "hpx\.parallel\.v1\.count$.*"
+parallel::count                       "count" "hpx\.parallel\.v1\.count$"
 parallel::count_if                    "count_if" "hpx\.parallel\.v1\.count_if.*"
 
 # hpx/parallel/algorithms/equal.hpp
@@ -520,16 +520,16 @@ unwrapped                             "" "header\.hpx\.util\.unwrapped.*"
 unwrapped2                            "" "header\.hpx\.util\.unwrapped2.*"
 
 # hpx/hpx_finalize.hpp
-finalize                              "" "hpx\.finalize.*"
-terminate                             "" "hpx\.terminate.*"
-disconnect                            "" "hpx\.disconnect.*"
-stop                                  "" "hpx\.stop.*"
+finalize                              "" "hpx\.finalize_id.*"
+terminate                             "" "hpx\.terminate$"
+disconnect                            "" "hpx\.disconnect_id.*"
+stop                                  "" "hpx\.stop$"
 
 # hpx/hpx_init.hpp
-init                                  "" "hpx\.init.*"
+init                                  "" "hpx\.init_id.*"
 
 # hpx/hpx_start.hpp
-start                                 "" "hpx\.start.*"
+start                                 "" "hpx\.start_id.*"
 
 # hpx/performance_counters/manage_counter_type.hpp
 install_counter_type                  "" "hpx\.performance_counters\.install_counter_type.*"

diff --git a/docs/manual/applications.qbk b/docs/manual/applications.qbk
@@ -1,5 +1,5 @@
 [/=============================================================================
-    Copyright (C) 2007-2013 Hartmut Kaiser
+    Copyright (C) 2007-2017 Hartmut Kaiser
 
     Distributed under the Boost Software License, Version 1.0. (See accompanying
     file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
@@ -53,6 +53,12 @@ removed from the list of values passed to `argc`/`argv` of the function
 options which are not recognized by the __hpx__ runtime system (see the section
 __commandline__ for more details on what options are recognized by __hpx__).
 
+[note In this mode all one-letter-shortcuts are disabled which are normally
+      available on the __hpx__ command line (such as `-t` or `-l`, see
+      __commandline__). This is done to minimize any possible interaction between
+      the command line options recognized by the __hpx__ runtime system and
+      any command line options defined by the application.]
+
 The value returned from the function `main()` as shown above will be returned
 to the operating system as usual.
 
@@ -114,6 +120,11 @@ runtime system.
 The header file to include for this method of using __hpx__ is
 [headerref hpx/hpx_init.hpp `hpx/hpx_init.hpp`].
 
+There are many additional overloads of [funcref hpx::init `hpx::init`]
+available, such as for instance to provide your own entry point function instead
+of [funcref hpx_main `hpx_main`]. Please refer to the function documentation for
+more details (see: [headerref hpx/hpx_init.hpp `hpx/hpx_init.hpp`]).
+
 [heading:flexible Supply your own main __hpx__ entry point while avoiding to block the main thread]
 
 With this method you need to provide an explicit main thread function named
@@ -171,4 +182,9 @@ The value returned from [funcref hpx_main `hpx_main`] will be returned from
 The header file to include for this method of using __hpx__ is
 [headerref hpx/hpx_start.hpp `hpx/hpx_start.hpp`].
 
+There are many additional overloads of [funcref hpx::start `hpx::start`]
+available, such as for instance to provide your own entry point function instead
+of [funcref hpx_main `hpx_main`]. Please refer to the function documentation for
+more details (see: [headerref hpx/hpx_start.hpp `hpx/hpx_start.hpp`]).
+
 [endsect]
diff --git a/hpx/hpx_init.hpp b/hpx/hpx_init.hpp
@@ -37,16 +37,15 @@ int hpx_main(boost::program_options::variables_map& vm);
 #endif
 
 ///////////////////////////////////////////////////////////////////////////////
-/// \namespace hpx_startup
+/// \cond NOINTERNAL
 namespace hpx_startup
 {
-#ifndef DOXYGEN
     // As an alternative, the user can provide a function hpx_startup::user_main,
     // which is semantically equivalent to the plain old C-main.
     int user_main();
     int user_main(int argc, char** argv);
-#endif
 }
+/// \endcond
 
 ///////////////////////////////////////////////////////////////////////////////
 /// \namespace hpx

diff --git a/hpx/hpx_start.hpp b/hpx/hpx_start.hpp
@@ -31,16 +31,15 @@ int hpx_main(boost::program_options::variables_map& vm);
 #endif
 
 ///////////////////////////////////////////////////////////////////////////////
-/// \namespace hpx_startup
+/// \cond NOINTERNAL
 namespace hpx_startup
 {
-#ifndef DOXYGEN
     // As an alternative, the user can provide a function hpx_startup::user_main,
     // which is semantically equivalent to the plain old C-main.
     int user_main();
     int user_main(int argc, char** argv);
-#endif
 }
+/// \endcond
 
 ///////////////////////////////////////////////////////////////////////////////
 /// \namespace hpx