Skip to content

Commit

Permalink
doc: remove usage of :members:
Browse files Browse the repository at this point in the history
It's not supported by breathe.

Signed-off-by: Gerard Marull-Paretas <[email protected]>
  • Loading branch information
gmarull committed Aug 4, 2023
1 parent 1f01ace commit d6360fd
Show file tree
Hide file tree
Showing 12 changed files with 0 additions and 141 deletions.
39 changes: 0 additions & 39 deletions crypto/doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ nRF CC310 bootloader crypto library

.. doxygengroup:: nrf_cc310_bl
:project: nrfxlib
:members:


.. _crypto_api_nrf_cc3xx_platform:
Expand All @@ -24,63 +23,54 @@ nRF CC3XX platform library

.. doxygengroup:: nrf_cc3xx_platform
:project: nrfxlib
:members:

CC3XX Platform - Defines
========================

.. doxygengroup:: nrf_cc3xx_platform_defines
:project: nrfxlib
:members:

CC3XX Platform - Initialization APIs
====================================

.. doxygengroup:: nrf_cc3xx_platform_init
:project: nrfxlib
:members:

CC3XX Platform - Entropy APIs
=============================

.. doxygengroup:: nrf_cc3xx_platform_entropy
:project: nrfxlib
:members:

CC3XX Platform - Mutex APIs
===========================

.. doxygengroup:: nrf_cc3xx_platform_mutex
:project: nrfxlib
:members:

CC3XX Platform - Abort APIs
===========================

.. doxygengroup:: nrf_cc3xx_platform_abort
:project: nrfxlib
:members:

CC3XX Platform - KMU APIs
=========================

.. doxygengroup:: nrf_cc3xx_platform_kmu
:project: nrfxlib
:members:

CC3XX Platform - CTR-DRBG APIs
==============================

.. doxygengroup:: nrf_cc3xx_platform_ctr_drbg
:project: nrfxlib
:members:

CC3XX Platform - HMAC-DRBG APIs
===============================

.. doxygengroup:: nrf_cc3xx_platform_hmac_drbg
:project: nrfxlib
:members:

.. _crypto_api_nrf_cc3xx_mbedcrypto:

Expand All @@ -89,14 +79,12 @@ nRF CC3XX mbedcrypto library

.. doxygengroup:: nrf_cc3xx_mbedcrypto
:project: nrfxlib
:members:

KMU/KDR APIs
========================

.. doxygengroup:: nrf_cc3xx_mbedcrypto_kmu
:project: nrfxlib
:members:


.. _crypto_api_nrf_oberon:
Expand All @@ -106,156 +94,133 @@ nrf_oberon crypto library

.. doxygengroup:: ocrypto
:project: nrfxlib
:members:

AES - Advanced Encryption Standard APIs
=======================================

.. doxygengroup:: ocrypto_aes
:project: nrfxlib
:members:

AES-CTR - AES Counter Mode
--------------------------

.. doxygengroup:: ocrypto_aes_ctr
:project: nrfxlib
:members:

AES EAX APIs
------------

.. doxygengroup:: ocrypto_aes_eax
:project: nrfxlib
:members:

AES GCM - AES Galois/Counter Mode APIs
--------------------------------------

.. doxygengroup:: ocrypto_aes_gcm
:project: nrfxlib
:members:

AES key sizes
-------------

.. doxygengroup:: ocrypto_aes_key
:project: nrfxlib
:members:

ChaCha20-Poly1305
=================

.. doxygengroup:: ocrypto_chacha_poly
:project: nrfxlib
:members:

ChaCha20-Poly1305 APIs
----------------------

.. doxygengroup:: ocrypto_chacha_poly_inc
:project: nrfxlib
:members:

ChaCha20 APIs
-------------

.. doxygengroup:: ocrypto_chacha
:project: nrfxlib
:members:

Constant time APIs
==================

.. doxygengroup:: ocrypto_constant_time
:project: nrfxlib
:members:

ECC secp256r1 low-level APIs
============================

.. doxygengroup:: ocrypto_p256
:project: nrfxlib
:members:

ECC Curve25519 low-level APIs
=============================

.. doxygengroup:: ocrypto_curve25519
:project: nrfxlib
:members:

ECDH APIs
=========

.. doxygengroup:: ocrypto_ecdh_p256
:project: nrfxlib
:members:

.. doxygengroup:: ocrypto_ecdh_p224
:project: nrfxlib
:members:


ECDSA APIs
==========

.. doxygengroup:: ocrypto_ecdsa_p256
:project: nrfxlib
:members:

.. doxygengroup:: ocrypto_ecdsa_p224
:project: nrfxlib
:members:

Ed25519 APIs
=============

.. doxygengroup:: ocrypto_ed25519
:project: nrfxlib
:members:

HKDF - HMAC based Key Derivation Function
=========================================

.. doxygengroup:: ocrypto_hkdf
:project: nrfxlib
:members:

HKDF APIs using SHA-256
-----------------------

.. doxygengroup:: ocrypto_hkdf_sha256
:project: nrfxlib
:members:

HKDF APIs using SHA-512
-----------------------

.. doxygengroup:: ocrypto_hkdf_512
:project: nrfxlib
:members:

HMAC - Hash-based Aessage Authentication Code
=============================================

.. doxygengroup:: ocrypto_hmac
:project: nrfxlib
:members:

HMAC APIs using SHA-256
-----------------------

.. doxygengroup:: ocrypto_hmac_sha256
:project: nrfxlib
:members:

HMAC APIs using SHA-512
-----------------------

.. doxygengroup:: ocrypto_hmac_sha512
:project: nrfxlib
:members:

RSA - Rivest-Shamir-Adleman algorithm
=====================================
Expand Down Expand Up @@ -283,25 +248,21 @@ SHA-256 APIs

.. doxygengroup:: ocrypto_sha_256
:project: nrfxlib
:members:

SHA-512 APIs
============

.. doxygengroup:: ocrypto_sha_512
:project: nrfxlib
:members:

SRP - Secure Remote Password APIs
=================================

.. doxygengroup:: ocrypto_srp
:project: nrfxlib
:members:

SRPT - Secure Real-Time Transport Protocol APIs
===============================================

.. doxygengroup:: ocrypto_srtp
:project: nrfxlib
:members:
3 changes: 0 additions & 3 deletions gzll/doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,15 @@ API documentation

.. doxygengroup:: gzll_api
:project: nrfxlib
:members:

Constants
*********

.. doxygengroup:: gzll_constants
:project: nrfxlib
:members:

Glue layer
**********

.. doxygengroup:: gzll_glue
:project: nrfxlib
:members:
2 changes: 0 additions & 2 deletions lc3/doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ Translation layer API documentation
.. doxygengroup:: LC3_translation
:project: nrfxlib
:members:

LC3 API documentation
*********************
Expand All @@ -24,4 +23,3 @@ LC3 API documentation
.. doxygengroup:: LC3
:project: nrfxlib
:members:
Loading

0 comments on commit d6360fd

Please sign in to comment.