Skip to content

Commit 7e887cc

Browse files
greg-fercarlescufi
authored andcommitted
doc: remove duplicated headers for API
Removed duplicated headers in include/ added in PR nrfconnect#13581. Updated doxyfile to be able to build from the correct headers. NCSDK-35801. Signed-off-by: Grzegorz Ferenc <[email protected]>
1 parent 69a404c commit 7e887cc

File tree

5 files changed

+8
-455
lines changed

5 files changed

+8
-455
lines changed

doc/nrf/libraries/security/trusted_storage.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -193,22 +193,21 @@ This library has dependencies to the following libraries:
193193
* :ref:`lib_hw_unique_key`
194194
* :ref:`Zephyr's settings subsystem <zephyr:settings_api>`
195195

196-
197196
API documentation
198197
*****************
199198

200199
Protected storage
201200
=================
202201

203-
| Header file: :file:`include/protected_storage.h`
202+
| Header file: :file:`subsys/trusted_storage/include/psa/protected_storage.h`
204203
| Source files: :file:`subsys/secure_storage/src/protected_storage/backend_interface.c`
205204
206205
.. doxygengroup:: protected_storage
207206

208207
Internal trusted storage
209208
========================
210209

211-
| Header file: :file:`include/internal_trusted_storage.h`
210+
| Header file: :file:`subsys/trusted_storage/include/psa/internal_trusted_storage.h`
212211
| Source files: :file:`subsys/secure_storage/src/internal_trusted_storage/backend_interface.c`
213212
214213
.. doxygengroup:: internal_trusted_storage

doc/nrf/nrf.doxyfile.in

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -962,7 +962,8 @@ INPUT = @DOCSET_SOURCE_BASE@/applications \
962962
@DOCSET_SOURCE_BASE@/subsys/nrf_security/include/psa/crypto_driver_contexts_composites.h \
963963
@DOCSET_SOURCE_BASE@/subsys/nrf_security/include/psa/crypto_driver_contexts_key_derivation.h \
964964
@DOCSET_SOURCE_BASE@/subsys/nrf_security/include/psa/crypto_driver_contexts_primitives.h \
965-
@DOCSET_SOURCE_BASE@/subsys/nrf_security/include/nrf_security_api_structure.h
965+
@DOCSET_SOURCE_BASE@/subsys/nrf_security/include/nrf_security_api_structure.h \
966+
@DOCSET_SOURCE_BASE@/subsys/trusted_storage/include/psa \
966967

967968
# This tag can be used to specify the character encoding of the source files
968969
# that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -933,7 +933,10 @@ Gazell libraries
933933
Security libraries
934934
------------------
935935

936-
|no_changes_yet_note|
936+
* :ref:`trusted_storage_readme` library:
937+
938+
* Updated the API documentation to be based on headers in :file:`subsys/trusted_storage/include/psa` instead of :file:`include/`.
939+
* Removed the :file:`internal_trusted_storage.h` and :file:`protected_storage.h` files from :file:`include/` as they were duplicating the same files in :file:`subsys/trusted_storage/include/psa`.
937940

938941
Modem libraries
939942
---------------

include/internal_trusted_storage.h

Lines changed: 0 additions & 169 deletions
This file was deleted.

0 commit comments

Comments
 (0)