Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit66ad9f8

Browse files
committed
Outline of Reference Manual
This is one of the major missing pieces of the documentation. Thiscommit attempts to note and give an outline of the reference manual forpublic-facing functions.This first commit concentrates on the HTTP client and server interfaceswhich would be the higher impact contents of the library.
1 parent09cccd8 commit66ad9f8

File tree

4 files changed

+76
-0
lines changed

4 files changed

+76
-0
lines changed

‎libs/network/doc/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ Contents
9696
techniques.rst
9797
history.rst
9898
install.rst
99+
reference.rst
99100
references.rst
100101

101102
.. _Boost:http://www.boost.org/

‎libs/network/doc/reference.rst‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
Reference Manual
3+
================
4+
5+
This reference manual refers to the API documentation of the public interfaces
6+
to the different client and/or server implementations within:mod:`cpp-netlib`.
7+
8+
..toctree::
9+
:maxdepth:2
10+
11+
reference_http_client.rst
12+
reference_http_server.rst
13+
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
HTTP Client API
3+
===============
4+
5+
General
6+
-------
7+
8+
.. FIXME describe the general API for the HTTP Clients
9+
10+
Implementations
11+
---------------
12+
13+
.. FIXME describe the internal implementation, with diagrams if at all possible
14+
and within reasonable efforts.
15+
16+
Synchronous Clients
17+
~~~~~~~~~~~~~~~~~~~
18+
19+
.. FIXME show the table of tags that enable the synchronous implementation.
20+
21+
Asynchronous Clients
22+
~~~~~~~~~~~~~~~~~~~~
23+
24+
.. FIXME show the table of tags that enable the asynchronous implementation.
25+
26+
Member Functions
27+
----------------
28+
29+
.. FIXME show the table of publicly-accessible member functions.
30+
31+
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
HTTP Server API
3+
===============
4+
5+
General
6+
-------
7+
8+
.. FIXME describe the general API for the HTTP Servers
9+
10+
Implementations
11+
---------------
12+
13+
.. FIXME describe the internal implementation, with diagrams if at all possible
14+
and within reasonable efforts.
15+
16+
Synchronous Servers
17+
~~~~~~~~~~~~~~~~~~~
18+
19+
.. FIXME show the table of tags that enable the synchronous implementation.
20+
21+
Asynchronous Servers
22+
~~~~~~~~~~~~~~~~~~~~
23+
24+
.. FIXME show the table of tags that enable the asynchronous implementation.
25+
26+
Member Functions
27+
----------------
28+
29+
.. FIXME show the table of publicly-accessible member functions.
30+
31+

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp