X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fcontributing%2Fdocumentation.rst;h=375ea64ba8ee98ad0290e8207e7c30f30a27be17;hb=47909357a0697fe9aaf4f0f27939f4edcdbb5e22;hp=550d8dec281e5eab9360bc78145e1d20e100909b;hpb=e85373edf0857f1774f6e519bd2af669d6eaeb2b;p=dpdk.git diff --git a/doc/guides/contributing/documentation.rst b/doc/guides/contributing/documentation.rst index 550d8dec28..375ea64ba8 100644 --- a/doc/guides/contributing/documentation.rst +++ b/doc/guides/contributing/documentation.rst @@ -82,7 +82,7 @@ added to by the developer. * **API documentation** The API documentation explains how to use the public DPDK functions. - The `API index page `_ shows the generated API documentation with related groups of functions. + The `API index page `_ shows the generated API documentation with related groups of functions. The API documentation should be updated via Doxygen comments when new functions are added. @@ -561,14 +561,14 @@ Hyperlinks ~~~~~~~~~~ * Links to external websites can be plain URLs. - The following is rendered as http://dpdk.org:: + The following is rendered as https://dpdk.org:: - http://dpdk.org + https://dpdk.org * They can contain alternative text. - The following is rendered as `Check out DPDK `_:: + The following is rendered as `Check out DPDK `_:: - `Check out DPDK `_ + `Check out DPDK `_ * An internal link can be generated by placing labels in the document with the format ``.. _label_name``. @@ -666,7 +666,7 @@ The following are some guidelines for use of Doxygen in the DPDK API documentati */ In the API documentation the functions will be rendered as links, see the - `online section of the rte_ethdev.h docs `_ that contains the above text. + `online section of the rte_ethdev.h docs `_ that contains the above text. * The ``@see`` keyword can be used to create a *see also* link to another file or library. This directive should be placed on one line at the bottom of the documentation section.