You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Documentation: link to the specification separately
Link to rendered copies of the specification on a separate branch,
since the implementation is not always up-to-date with the
specification.
Fix the broken link to the HTML to something that works on the web.
Add instructions to generate the library documentation in HTML locally.
Copy file name to clipboardExpand all lines: README.md
+17-3Lines changed: 17 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -24,10 +24,24 @@ Mbed Crypto is a reference implementation of the PSA cryptography API. It is wri
24
24
25
25
## Documentation
26
26
27
-
Since the Mbed Crypto library is a reference implementation of the PSA cryptography API, the library's API documentation is the PSA cryptography API specification. The PSA cryptography API specification consists of the following documents:
27
+
The Mbed Crypto library is a reference implementation of the PSA cryptography API. Please refer to the PSA Cryptography API documents for an overview of the library's interfaces and a detailed description of the types, macros and functions that it provides.
28
28
29
-
* The [PSA Cryptography API overview](docs/PSA_Crypto_API_Overview.pdf).
30
-
* The [PSA Cryptography API detailed function reference](docs/PSA_Crypto_API_Reference.pdf), which you can also browse in [HTML format](docs/html/modules.html).
29
+
There are currently a few deviations where the library does not yet implement the latest version of the specification. Please refer to the [compliance issues on Github](https://github.com/ARMmbed/mbed-crypto/labels/compliance) for an up-to-date list.
30
+
31
+
### PSA Cryptography API
32
+
33
+
The PSA cryptography API specification consists of the following documents:
34
+
35
+
* The [PSA Cryptography API overview](https://github.com/gilles-peskine-arm/mbed-crypto/blob/psa-crypto-api-1.0-beta-docs/docs/PSA_Cryptography_API_Specification.pdf).
36
+
* The [PSA Cryptography API detailed function reference](https://github.com/ARMmbed/mbed-crypto/blob/psa-crypto-api/docs/PSA_Cryptography_API_Reference.pdf), which you can also browse in [HTML format](https://htmlpreview.github.io/?https://github.com/ARMmbed/mbed-crypto/blob/psa-crypto-api/docs/html/modules.html).
37
+
38
+
### Browsable library documentation
39
+
40
+
To generate a local copy of the library documentation in HTML format:
41
+
42
+
1. Make sure that [Doxygen](http://www.doxygen.nl/) is installed. We use version 1.8.11 but slightly older or more recent versions should work.
43
+
1. Run `make apidoc`.
44
+
1. Browse `apidoc/index.html` or `apidoc/modules.html`.
0 commit comments