Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
document Mailboxes in the new way
[simgrid.git] / include / simgrid / s4u / Mailbox.hpp
index 1b421c8..119b1d8 100644 (file)
@@ -27,15 +27,17 @@ class XBT_PUBLIC Mailbox {
   ~Mailbox() = default;
 
 public:
+#ifndef DOXYGEN
   /** private function, do not use. FIXME: make me protected */
   kernel::activity::MailboxImpl* get_impl() const { return pimpl_; }
+#endif
 
   /** @brief Retrieves the name of that mailbox as a C++ string */
   const xbt::string& get_name() const;
   /** @brief Retrieves the name of that mailbox as a C string */
   const char* get_cname() const;
 
-  /** Retrieve the mailbox associated to the given name */
+  /** Retrieve the mailbox associated to the given name. Mailboxes are created on demand. */
   static Mailbox* by_name(const std::string& name);
 
   /** Returns whether the mailbox contains queued communications */