Files
mscclpp/docs
Changho Hwang 1bf4e8c90e connect() APIs changed to return an instance instead of a shared_ptr (#680)
The key purpose is handling all mscclpp objects' memory internally by
hiding shared pointers from user APIs.
* `Connection` class is now a wrapper of `BaseConnection` class that is
equivalent to the previous `Connection` class
* `connect()` methods now return `Connection` instead of
`std::shared_ptr<Connection>`
* Removed `connectOnSetup()` method
2025-11-15 11:40:40 -08:00
..
2025-08-07 15:37:37 -07:00
2025-10-23 17:50:33 -07:00
2025-08-11 10:34:29 -07:00
2025-10-23 00:34:53 +00:00
2025-10-23 00:34:53 +00:00
2025-10-23 00:34:53 +00:00
2023-11-22 12:58:04 -08:00
2025-10-23 00:34:53 +00:00
2025-08-07 15:37:37 -07:00
2025-10-23 00:34:53 +00:00
2025-10-29 10:03:02 -07:00
2024-10-18 06:08:31 +00:00
2025-10-23 00:34:53 +00:00
2025-08-07 15:37:37 -07:00

How to build docs

  1. Install doxygen.

    $ sudo apt-get install doxygen graphviz
    
  2. Install Python packages below. If you install them on the user's local, you need to include ~/.local/bin to $PATH (to use sphinx-build).

    $ sudo python3 -m pip install -r ./requirements.txt
    
  3. Create Doxygen documents.

    $ doxygen
    
  4. Create Sphinx documents.

    $ make html
    
  5. Done. The HTML files will be on _build/ directory.