Skip to content

GitLab

Commit ff52f171 authored by Davis King's avatar Davis King
Browse files

updated docs

parent 7f39ef4e
Show whitespace changes
Inline Side-by-side
Showing with 42 additions and 5 deletions
docs/docs/network.xml
View file @ ff52f171
...@@ -9,11 +9,9 @@ ...@@ -9,11 +9,9 @@
<body> <body>
<br/><br/> <br/><br/>
<p> <p>
To use any of these objects all you need to do is #include the file indicated in the This page documents tools built on top of the dlib <a href="api.html#sockets">sockets API</a>.
short section about the component you would like to use. Pick which implementation you Therefore, all these tools are focused on providing some kind of higher level networking
would like and typedef it to something nice. Here is an example of creating a typedef for abstraction or service.
a linker using the first kernel implementation. <br/>
<tt>typedef dlib::linker::kernel_1a linker1;</tt>
</p> </p>
</body> </body>
...@@ -28,7 +26,13 @@ ...@@ -28,7 +26,13 @@
<item>server</item> <item>server</item>
<item>bridge</item> <item>bridge</item>
<item>sockstreambuf</item> <item>sockstreambuf</item>
</section>
<section>
<name>BSP</name>
<item>bsp_connect</item>
<item>bsp_listen</item>
<item>bsp_context</item>
</section> </section>
</top> </top>
...@@ -91,6 +95,36 @@ ...@@ -91,6 +95,36 @@
</examples> </examples>
</component> </component>
<!-- ************************************************************************* -->
<component>
<name>bsp_connect</name>
<file>dlib/bsp.h</file>
<spec_file link="true">dlib/bsp/bsp_abstract.h</spec_file>
<description>
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>bsp_listen</name>
<file>dlib/bsp.h</file>
<spec_file link="true">dlib/bsp/bsp_abstract.h</spec_file>
<description>
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>bsp_context</name>
<file>dlib/bsp.h</file>
<spec_file link="true">dlib/bsp/bsp_abstract.h</spec_file>
<description>
</description>
</component>
<!-- ************************************************************************* --> <!-- ************************************************************************* -->
<component checked="true"> <component checked="true">
......
docs/docs/term_index.xml
View file @ ff52f171
...@@ -1222,6 +1222,9 @@ ...@@ -1222,6 +1222,9 @@
<term file="dlib/bridge/bridge_abstract.h.html" name="transmit"/> <term file="dlib/bridge/bridge_abstract.h.html" name="transmit"/>
<term file="dlib/bridge/bridge_abstract.h.html" name="receive"/> <term file="dlib/bridge/bridge_abstract.h.html" name="receive"/>
<term file="dlib/bridge/bridge_abstract.h.html" name="bridge_status"/> <term file="dlib/bridge/bridge_abstract.h.html" name="bridge_status"/>
<term file="network.html" name="bsp_context"/>
<term file="network.html" name="bsp_listen"/>
<term file="network.html" name="bsp_connect"/>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment