Doxygen cleanup (#75)

* void functions should not have @return

* Rearrange functions to eliminate doxygen warning

* Fix broken @ref to allocation

* Fix doxygen error about illegal newlines

Co-authored-by: Sven Lundgren <[email protected]>

Doxyfile.in

@@ -259,7 +259,7 @@ TAB_SIZE               = 4
 # commands \{ and \} for these it is advised to use the version @{ and @} or use
 # a double escape (\\{ and \\})
 
-ALIASES                = "envvar{1}=@anchor \1 @par \1 \n"
+ALIASES                = "envvar{1}=@anchor \1 @par \1"
 
 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
 # only. Doxygen will then generate output that is more tailored for C. For

src/allocators/collective_allocator.hpp

@@ -69,7 +69,7 @@ namespace argo {
 	 * -# If the user has provided constructor arguments, then initialization is
 	 *    performed.
 	 * -# The user can explicitly override these defaults using the appropriate
-	 *    allocation parameters (@ref allocation).
+	 *    allocation parameters (@ref argo::allocation).
 	 * -# Synchronization is performed after initialization.
 	 * -# The user can override the behaviour by using the allocation
 	 *    parameters.
@@ -129,7 +129,7 @@ namespace argo {
 	 *
 	 * -# The destructors are called by default (deinitialization).
 	 * -# If the type is trivially destructible, no destructors are called.
-	 * -# The user can explicilty override this behaviour (see @ref allocation).
+	 * -# The user can explicitly override this behaviour (@ref argo::allocation).
 	 * -# If the destructor is called, the function will also synchronize.
 	 * -# The user can explicitly override this behaviour.
 	 *

src/allocators/dynamic_allocator.hpp

@@ -214,7 +214,7 @@ namespace argo {
 	 * -# If the user has provided constructor arguments, then initialization is
 	 *    performed.
 	 * -# The user can explicitly override these defaults using the appropriate
-	 *    allocation parameters (@ref allocation).
+	 *    allocation parameters (@ref argo::allocation).
 	 * -# Synchronization is NOT performed at any case
 	 * -# User synchronization parameters are ignored
 	 */
@@ -257,7 +257,7 @@ namespace argo {
 	 * -# Deinitialization (calling the destructors) is performed by default.
 	 * -# If the type is trivially destructible, no destructors are called.
 	 * -# The user can override the default behaviour with the allocation
-	 *  parameters (@ref allocation).
+	 *  parameters (@ref argo::allocation).
 	 * -# Synchronization is NOT performed at any case
 	 * -# User synchronization parameters are ignored
 	 */