diff --git a/doc/source/api_user.rst b/doc/source/api_user.rst
deleted file mode 100755
index ad59579..0000000
--- a/doc/source/api_user.rst
+++ /dev/null
@@ -1,17 +0,0 @@
-.. _user-api:
-
-API Reference
-*************
-
-Runtime System Users use WRENCH to simulate application workload
-executions using an already available, in-simulation implementation
-of a runtime system that uses Core Services to execution that workload.
-
-Navigate through the sidebar to view the documentation for each class
-under the WRENCH User API.
-
-.. toctree::
- :hidden:
- :glob:
-
- api_user/*
diff --git a/doc/source/conf.py b/doc/source/conf.py
index de50349..5700c54 100755
--- a/doc/source/conf.py
+++ b/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'
diff --git a/doc/source/getting_started.rst b/doc/source/getting_started.rst
deleted file mode 100755
index 005363a..0000000
--- a/doc/source/getting_started.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-.. _getting-started:
-
-Getting started
-***************
-
-TBD
diff --git a/doc/source/images/simgrid_logo.png b/doc/source/images/simgrid_logo.png
index 1fdf138..fb49380 100644
Binary files a/doc/source/images/simgrid_logo.png and b/doc/source/images/simgrid_logo.png differ
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 36b6928..1bbe413 100755
--- a/doc/source/index.rst
+++ b/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/*
+
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
deleted file mode 100755
index bc9dbf6..0000000
--- a/doc/source/installation.rst
+++ /dev/null
@@ -1,25 +0,0 @@
-.. _install:
-
-Installing FSMOD
-*****************
-
-.. _install-prerequisites:
-
-Prerequisites
-=============
-
-
-Required Dependencies
----------------------
-
-- `SimGrid `__
-
-Optional Dependencies
----------------------
-
-- `Google Test `__ – version 1.8
- or higher (only required for running tests)
-
-.. _install-source:
-
-
diff --git a/include/FileSystem.hpp b/include/FileSystem.hpp
index 4a87df3..a24398a 100644
--- a/include/FileSystem.hpp
+++ b/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, sg_size_t size);
void mount_partition(const std::string &mount_point, std::shared_ptr storage, const std::string& size);
- [[nodiscard]] std::shared_ptr partition_by_name(const std::string& name) const;
- [[nodiscard]] std::shared_ptr 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 open(const std::string& full_path);
+
+ /** \cond EXCLUDE_FROM_DOCUMENTATION */
+
+ [[nodiscard]] std::shared_ptr partition_by_name(const std::string& name) const;
+ [[nodiscard]] std::shared_ptr 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
diff --git a/src/FileSystem.cpp b/src/FileSystem.cpp
index 45c58fa..2e235fd 100644
--- a/src/FileSystem.cpp
+++ b/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::string>
@@ -220,4 +221,4 @@ namespace simgrid::module::fs {
-}
\ No newline at end of file
+}
diff --git a/src/JBODStorage.cpp b/src/JBODStorage.cpp
index 5de51b6..4b3df54 100644
--- a/src/JBODStorage.cpp
+++ b/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::create(const std::string& name, const std::vector& disks) {
diff --git a/src/OneDiskStorage.cpp b/src/OneDiskStorage.cpp
index aeace64..7f252c3 100644
--- a/src/OneDiskStorage.cpp
+++ b/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::create(const std::string& name, s4u::Disk* disk) {