Skip to content
Permalink
Browse files

Merge pull request #805 from readthedocs/agj/more-api-docs

Add more domain doc examples
  • Loading branch information...
agjohnson committed Aug 3, 2019
2 parents a732d61 + 604fe08 commit 6909b4acb2319330532fd449d72d0879c39b3813
Showing with 67 additions and 0 deletions.
  1. +67 −0 docs/demo/api.rst
@@ -28,6 +28,73 @@ C++ API

Some cpp class

.. cpp:member:: float Sphinx::version

The description of Sphinx::version.

.. cpp:var:: int version

The description of version.

.. cpp:type:: std::vector<int> List

The description of List type.

.. cpp:enum:: MyEnum

An unscoped enum.

.. cpp:enumerator:: A

.. cpp:enum-class:: MyScopedEnum

A scoped enum.

.. cpp:enumerator:: B

.. cpp:enum-struct:: protected MyScopedVisibilityEnum : std::underlying_type<MySpecificEnum>::type

A scoped enum with non-default visibility, and with a specified underlying type.

.. cpp:enumerator:: B


JavaScript API
==============

.. Copied from sphinx-doc/sphinx/tests/roots
.. js:module:: module_a.submodule

* Link to :js:class:`ModTopLevel`

.. js:class:: ModTopLevel

* Link to :js:meth:`mod_child_1`
* Link to :js:meth:`ModTopLevel.mod_child_1`

.. js:method:: ModTopLevel.mod_child_1

* Link to :js:meth:`mod_child_2`

.. js:method:: ModTopLevel.mod_child_2

* Link to :js:meth:`module_a.submodule.ModTopLevel.mod_child_1`

.. js:module:: module_b.submodule

* Link to :js:class:`ModTopLevel`

.. js:class:: ModNested

.. js:method:: nested_child_1

* Link to :js:meth:`nested_child_2`

.. js:method:: nested_child_2

* Link to :js:meth:`nested_child_1`


Generated Index
===============

0 comments on commit 6909b4a

Please sign in to comment.
You can’t perform that action at this time.