diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-12-16 07:46:06 +0100 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2021-12-16 07:47:32 +0100 |
| commit | 869075be652b31fde3bc87d731fa1f8cdc7150cb (patch) | |
| tree | 1c8560d785f2cd1ebf94f90cd9e2ecdc0ca9161b | |
| parent | modules: Update rtems (diff) | |
| download | rtems-central-869075be652b31fde3bc87d731fa1f8cdc7150cb.tar.bz2 | |
sphinxcontent: Improve formatting of structures
| -rw-r--r-- | rtemsspec/sphinxcontent.py | 2 | ||||
| -rw-r--r-- | rtemsspec/tests/test_interfacedoc.py | 2 |
2 files changed, 3 insertions, 1 deletions
diff --git a/rtemsspec/sphinxcontent.py b/rtemsspec/sphinxcontent.py index e0084af8..1fc3d3c7 100644 --- a/rtemsspec/sphinxcontent.py +++ b/rtemsspec/sphinxcontent.py @@ -224,6 +224,8 @@ def _get_value_sphinx_function(ctx: ItemGetValueContext) -> Any: def _get_value_sphinx_type(ctx: ItemGetValueContext) -> Any: + if ctx.item.get("definition-kind", "") == "struct-only": + return f"``struct {ctx.value[ctx.key]}``" return f":c:type:`{ctx.value[ctx.key]}`" diff --git a/rtemsspec/tests/test_interfacedoc.py b/rtemsspec/tests/test_interfacedoc.py index 07e96bc8..b57cf310 100644 --- a/rtemsspec/tests/test_interfacedoc.py +++ b/rtemsspec/tests/test_interfacedoc.py @@ -460,7 +460,7 @@ Function brief description. Function description. References to :term:`xs <x>`, :ref:`InterfaceVeryLongFunction`, :c:type:`Integer`, :c:type:`Enum`, :c:macro:`DEFINE`, :ref:`InterfaceVERYLONGMACRO`, Variable, -:c:macro:`ENUMERATOR_0`, :c:type:`Struct`, :ref:`a`, interface, :ref:`GroupA`, +:c:macro:`ENUMERATOR_0`, ``struct Struct``, :ref:`a`, interface, :ref:`GroupA`, and Group F. Second parameter is ``Param1``. .. code-block: |