Add more details for comparison operator and serialization

src/Simplex_tree/include/gudhi/Simplex_tree.h

@@ -638,7 +638,9 @@ class Simplex_tree {
  public:
   template<typename> friend class Simplex_tree;
 
-  /** \brief Checks if two simplex trees are equal. */
+  /** \brief Checks if two simplex trees are equal. Any extra data (@ref Simplex_data) stored in the simplices are
+   * ignored in the coomparison
+   */
   template<class OtherSimplexTreeOptions>
   bool operator==(Simplex_tree<OtherSimplexTreeOptions>& st2) {
     if ((null_vertex_ != st2.null_vertex_) ||
@@ -2533,6 +2535,8 @@ class Simplex_tree {
    *
    * @warning Serialize/Deserialize is not portable. It is meant to be read in a Simplex_tree with the same
    * SimplexTreeOptions and on a computer with the same architecture.
+   *
+   * Serialize/Deserialize ignore any extra data (@ref Simplex_data) stored in the simplices for now.
    */
   /* Let's take the following simplicial complex as example:         */
   /* (vertices are represented as letters to ease the understanding) */
@@ -2601,6 +2605,7 @@ class Simplex_tree {
    * @warning Serialize/Deserialize is not portable. It is meant to be read in a Simplex_tree with the same
    * SimplexTreeOptions and on a computer with the same architecture.
    *
+   * Serialize/Deserialize ignore any extra data (@ref Simplex_data) stored in the simplices for now.
    */
   void deserialize(const char* buffer, const std::size_t buffer_size) {
     GUDHI_CHECK(num_vertices() == 0, std::logic_error("Simplex_tree::deserialize - Simplex_tree must be empty"));