Some documentation simplification

doc/source/conf.py

@@ -70,17 +70,8 @@
 
 # The full version, including alpha/beta/rc tags
 
-breathe_projects = {
-    "user": "../../docs/2.2-dev/user/xml/"
-}
-version = '0.1-dev'
-release = '0.1-dev'
-
-
 breathe_projects = {
     "user": "../../docs/0.1/user/xml/",
-    "developer": "../../docs/0.1/developer/xml/",
-    "internal": "../../docs/0.1/internal/xml/",
 }
 version = '0.1'
 release = '0.1'

doc/source/index.rst

@@ -1,12 +1,15 @@
 .. _mainpage:
 
-.. figure::  images/simgrid_logo.png 
-   :scale:   20%
 
-TO WRITE
+The SimGrid File System Module: API Reference
+*********************************************
+
+Explore the API using the left search box and navigation bar.
 
 
 .. toctree::
-   installation.rst
-   getting_started.rst
-   api_user.rst
+  :hidden:
+  :glob:
+
+  api_user/*
+

include/FileSystem.hpp

@@ -16,8 +16,8 @@
 namespace simgrid::module::fs {
 
 	/**
-	 * @brief A CLASS
-	 */
+ 	* @brief A class that implements a file system abstraction
+ 	*/
     class XBT_PUBLIC FileSystem {
 
         const std::string name_;
@@ -29,9 +29,6 @@ namespace simgrid::module::fs {
         void mount_partition(const std::string &mount_point, std::shared_ptr<Storage> storage, sg_size_t size);
         void mount_partition(const std::string &mount_point, std::shared_ptr<Storage> storage, const std::string& size);
 
-        [[nodiscard]] std::shared_ptr<Partition> partition_by_name(const std::string& name) const;
-        [[nodiscard]] std::shared_ptr<Partition> partition_by_name_or_null(const std::string& name) const;
-
         void create_file(const std::string& full_path, sg_size_t size);
         void create_file(const std::string& full_path, const std::string& size);
 
@@ -43,6 +40,12 @@ namespace simgrid::module::fs {
         [[nodiscard]] sg_size_t file_size(const std::string& full_path) const;
 
         std::shared_ptr<File> open(const std::string& full_path);
+
+	/** \cond EXCLUDE_FROM_DOCUMENTATION    */
+
+        [[nodiscard]] std::shared_ptr<Partition> partition_by_name(const std::string& name) const;
+        [[nodiscard]] std::shared_ptr<Partition> partition_by_name_or_null(const std::string& name) const;
+
         virtual ~FileSystem() = default;
 
     protected:
@@ -55,6 +58,8 @@ namespace simgrid::module::fs {
 
         int num_open_files_ = 0;
 
+	/** \endcond */
+
     };
 
 } // namespace simgrid::module::fs

src/FileSystem.cpp

@@ -10,9 +10,10 @@
 #include "FileSystemException.hpp"
 
 namespace simgrid::module::fs {
+
     /**
      * @brief Private method to find the partition and path at mount point for an absolute path
-     * @param full_path: an absolute simplified file path
+     * @param simplified_path: an absolute simplified file path
      * @return
      */
     std::pair<std::shared_ptr<Partition>, std::string>
@@ -220,4 +221,4 @@ namespace simgrid::module::fs {
 
 
 
-}
+}

src/JBODStorage.cpp

@@ -8,7 +8,8 @@ namespace simgrid::module::fs {
     }
     /**
      * @brief Method to create an instance of a JBOD (Just a Bunch of Disks) storage
-     * @param disks: the disks
+     * @param name: the storage's name
+     * @param disks: the storage's disks
      * @return
      */
     std::shared_ptr<JBODStorage> JBODStorage::create(const std::string& name, const std::vector<s4u::Disk*>& disks) {

src/OneDiskStorage.cpp

@@ -5,7 +5,8 @@ namespace simgrid::module::fs {
 
     /**
      * @brief Method to create an instance of a one-disk storage
-     * @param disk: the disk
+     * @param name: the storage's name
+     * @param disk: the storage's disk
      * @return
      */
     std::shared_ptr<OneDiskStorage> OneDiskStorage::create(const std::string& name, s4u::Disk* disk) {