Some clarifications to BSD socket descriptions. Also added
rendering hints for some strings.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
Linking to API material requires knowing the pecularities of how
doxygen, sphinx, and breathe work. In an attempt to hide some of this
we're preparing the current docs to allow use of configuration defaults
that will let us more simply use a default role that will hunt for a
reference target in the various domains that are available by using a
default "role" of "all". This will let us use the simple notation
`functionname` or `typename` without fully specifying the reference as
:c:func:`functionname`.
This patch cleans up exising docs that were (incorrectly) using single
backtics where double backtics should have been used, and also found
some typos (such as a space between the role name and the reference,
such as :file: `filename`, and a missing colon such as
c:func:`functionname`)
This is a start to address issue #14313
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
Use proper link to Zephyr source files. Fix rendering of special
options like NET_OK, NET_DROP and NET_CONTINUE.
Add reference links to network technologies documents.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
The architecture document contained old information and is now
updated to match the reality.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
A new role :zephyr_file: is available that renders to a link to the file
or folder in GitHub. Find appropriate references using :file: and
convert to :zephyr_file: to take advantage of its linking capability.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
The VLAN documentation had double wording and proper links to files
in github was missing, which did not look good in the rendered HTML
page.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
Fix link to DNS Kconfig option. Add proper links to DNS files
in github. Fixed link to DNS sample application.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
The L2 documentation was describing functionality that has changed
recently. Now it should match the current reality.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
The Link Layer Discovery Protocol chapter was missing Overview
and also the API reference was not populated properly.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
Adding OpenAVnu/gptp and linuxptp links to the doc.
Also the "Application interfaces" chapter had some style issues.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
Group the networking chapters for reference document so that the
layout is more logical and easier to read.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
The UDP API functions are for Zephyr internal use only so do
not generate documentation for them.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
Add short overview for DHCPv4. Do not add dhcpv4 library internal
state in the documentation.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
Add more information about DNS resolver to documentation. Move
generic DNS information from the sample application into DNS
resolver documentation.
Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
1. There's now proper fdtable, pointer casting to "fd" is gone.
2. select() was implemented.
3. Enumerate implemented functions more thoroughly, so users can
fulltext-search them.
Signed-off-by: Paul Sokolovsky <paul.sokolovsky@linaro.org>
Move guides and APIs into separate directories and cleanup naming
introducing index files rather than named section files.
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
