Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix doxygen #578

Merged
merged 5 commits into from
Aug 9, 2024
Merged

docs: fix doxygen #578

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1fa11c1
chore: ignore docs/doxyxml
YuanYuYuan Aug 7, 2024
ef66fe0
docs: update the README of doxygen
YuanYuYuan Aug 7, 2024
0fabdfa
docs: fix the warnings
YuanYuYuan Aug 7, 2024
2a0764a
docs: remove the unnecessary step in macOS
YuanYuYuan Aug 7, 2024
1f91b0d
chore: address the review comment
YuanYuYuan Aug 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
_build
doxyxml
22 changes: 6 additions & 16 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,10 @@
zenoh-c API documentation is available on [Read the Docs](https://zenoh-c.readthedocs.io/en/latest/index.html).

-------------------------------
## How to build it
## How to build it

-- Ubuntu --

```bash
$ cd docs
$ sphinx-build -b html . _build/html
```

-- MacOS --

Update conf.py *Config.set_library_file* with the path to your *libclang.dylib* file.

```bash
$ cd docs
$ sphinx-build -b html . _build/html
```
```bash
cd docs
doxygen
sphinx-build -b html . _build/html
```
17 changes: 7 additions & 10 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Functions
.. doxygenfunction:: z_string_is_empty

String Array
-----------
------------
Types
^^^^^
.. doxygenstruct:: z_owned_string_array_t
Expand Down Expand Up @@ -234,9 +234,6 @@ Functions
.. doxygenfunction:: z_encoding_loan_mut
.. doxygenfunction:: z_encoding_check
.. doxygenfunction:: z_encoding_drop

.. doxygenfunction:: z_encoding_drop

.. doxygenfunction:: z_encoding_loan_default
.. doxygenfunction:: z_encoding_from_str
.. doxygenfunction:: z_encoding_from_substr
Expand Down Expand Up @@ -314,7 +311,7 @@ Predefined Encodings
.. doxygenfunction:: z_encoding_video_vp9

Reply Error
-----
-----------
Types
^^^^^
.. doxygenstruct:: z_loaned_reply_err_t
Expand Down Expand Up @@ -626,7 +623,7 @@ Functions
.. doxygenfunction:: z_ring_handler_sample_drop
.. doxygenfunction:: z_ring_handler_sample_loan
.. doxygenfunction:: z_ring_handler_sample_recv
.. doxygenfunction:: z_ring_handler_sample_try_recv
.. doxygenfunction:: z_ring_handler_sample_try_recv

Queryable
=========
Expand Down Expand Up @@ -702,7 +699,7 @@ Functions
.. doxygenfunction:: z_ring_handler_query_drop
.. doxygenfunction:: z_ring_handler_query_loan
.. doxygenfunction:: z_ring_handler_query_recv
.. doxygenfunction:: z_ring_handler_query_try_recv
.. doxygenfunction:: z_ring_handler_query_try_recv

Query
=====
Expand Down Expand Up @@ -767,7 +764,7 @@ Functions
.. doxygenfunction:: z_ring_handler_reply_drop
.. doxygenfunction:: z_ring_handler_reply_loan
.. doxygenfunction:: z_ring_handler_reply_recv
.. doxygenfunction:: z_ring_handler_reply_try_recv
.. doxygenfunction:: z_ring_handler_reply_try_recv

Scouting
========
Expand All @@ -789,8 +786,8 @@ Functions
.. doxygenfunction:: z_hello_locators
.. doxygenfunction:: z_hello_zid
.. doxygenfunction:: z_hello_loan
.. doxygenfunction:: z_hello_drop
.. doxygenfunction:: z_hello_null
.. doxygenfunction:: z_hello_drop
.. doxygenfunction:: z_hello_null
.. doxygenfunction:: z_hello_check

.. doxygenfunction:: z_whatami_to_view_string
Expand Down