AuroraMiddleware/asio
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Make some usability improvements to the generated documentation.

Browse Source
This commit is contained in:
chris 2004-05-26 06:33:23 +00:00
parent 82372055e4
commit 09b4e8317e
6 changed files with 71 additions and 76 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
asio/src/doc/asio_dox.txt
View File

@ -26,7 +26,7 @@ documentation</a> for more information on how to use <tt>boost::bind</tt>.
*/
/**
\mainpage
\mainpage asio Reference
<TABLE BORDER="0" WIDTH="100%">
<TR>
@ -39,23 +39,39 @@ documentation</a> for more information on how to use <tt>boost::bind</tt>.
\li asio::ipv4
\li asio::socket_option
<H2>Core Classes</H2>
<H2>Classes</H2>
\li asio::demuxer
\li asio::dgram_socket
\li asio::ipv4::address
\li asio::ipv4::tcp
\li asio::ipv4::udp
\li asio::locking_dispatcher
\li asio::socket_acceptor
\li asio::socket_connector
\li asio::stream_socket
\li asio::timer
<H2>Support Classes</H2>
\li asio::ipv4::address
\li asio::socket_error
\li asio::stream_socket
\li asio::thread
\li asio::timer
\li asio::timer_base
<H2>Class Templates</H2>
\li asio::basic_demuxer
\li asio::basic_dgram_socket
\li asio::basic_locking_dispatcher
\li asio::basic_socket_acceptor
\li asio::basic_socket_connector
\li asio::basic_stream_socket
\li asio::basic_timer
\li asio::buffered_recv_stream
\li asio::buffered_send_stream
\li asio::buffered_stream
\li asio::service_factory
</TD>
<TD VALIGN="TOP">
<H2>Free Functions</H2>
\li asio::recv
\li asio::recv_n
@ -70,26 +86,6 @@ documentation</a> for more information on how to use <tt>boost::bind</tt>.
\li asio::async_send_n
\li asio::async_send_at_least_n
</TD>
<TD VALIGN="TOP">
<H2>Core Templates</H2>
\li asio::basic_demuxer
\li asio::basic_dgram_socket
\li asio::basic_locking_dispatcher
\li asio::basic_socket_acceptor
\li asio::basic_socket_connector
\li asio::basic_stream_socket
\li asio::basic_timer
\li asio::service_factory
<H2>Stream Decorator Templates</H2>
\li asio::buffered_recv_stream
\li asio::buffered_send_stream
\li asio::buffered_stream
<H2>Type Traits</H2>
\li asio::is_recv_buffered
@ -110,5 +106,4 @@ documentation</a> for more information on how to use <tt>boost::bind</tt>.
</TD>
</TR>
</TABLE>
*/

6
asio/src/doc/asio_footer.htm
View File

@ -5,10 +5,10 @@
<B>$projectname $projectnumber</B>
</TD>
<TD ALIGN="RIGHT">
<A CLASS="qindex" HREF="index.html">Main Page</A> |
<A CLASS="qindex" HREF="index.html">Reference</A> |
<A CLASS="qindex" HREF="tutindex.html">Tutorials</A> |
<A CLASS="qindex" HREF="classes.html">Class Index</A> |
<A CLASS="qindex" HREF="functions.html">Member Index</A> |
<A CLASS="qindex" HREF="tutindex.html">Tutorial Index</A>
<A CLASS="qindex" HREF="functions.html">Member Index</A>
</TD>
</TR>
</TABLE>

6
asio/src/doc/asio_header.htm
View File

@ -11,10 +11,10 @@
<B>$projectname $projectnumber</B>
</TD>
<TD ALIGN="RIGHT">
<A CLASS="qindex" HREF="index.html">Main Page</A> |
<A CLASS="qindex" HREF="index.html">Reference</A> |
<A CLASS="qindex" HREF="tutindex.html">Tutorials</A> |
<A CLASS="qindex" HREF="classes.html">Class Index</A> |
<A CLASS="qindex" HREF="functions.html">Member Index</A> |
<A CLASS="qindex" HREF="tutindex.html">Tutorial Index</A>
<A CLASS="qindex" HREF="functions.html">Member Index</A>
</TD>
</TR>
</TABLE>

52
asio/src/examples/tutorial/daytime_dox.txt
View File

@ -1,9 +1,9 @@
/**
\page tutdaytime1 Tutorial Daytime.1 - A synchronous TCP daytime client
See the \ref tutdaytime1src \n
Return to the \ref tutindex \n
Go on to \ref tutdaytime2
See the \ref tutdaytime1src "full source listing" \n
Return to the \ref tutindex "tutorial index" \n
Next: \ref tutdaytime2
*/
@ -16,10 +16,10 @@ Return to \ref tutdaytime1
/**
\page tutdaytime2 Tutorial Daytime.2 - A synchronous TCP daytime server
See the \ref tutdaytime2src \n
Return to the \ref tutindex \n
Go back to \ref tutdaytime1 \n
Go on to \ref tutdaytime3
See the \ref tutdaytime2src "full source listing" \n
Return to the \ref tutindex "tutorial index" \n
Previous: \ref tutdaytime1 \n
Next: \ref tutdaytime3
*/
@ -57,10 +57,10 @@ be removed:
asio::async_send_n(*socket, send_buf, send_length,
boost::bind(handle_send, socket, send_buf)); @endcode
See the \ref tutdaytime3src \n
Return to the \ref tutindex \n
Go back to \ref tutdaytime2 \n
Go on to \ref tutdaytime4
See the \ref tutdaytime3src "full source listing" \n
Return to the \ref tutindex "tutorial index" \n
Previous: \ref tutdaytime2 \n
Next: \ref tutdaytime4
*/
@ -73,10 +73,10 @@ Return to \ref tutdaytime3
/**
\page tutdaytime4 Tutorial Daytime.4 - A synchronous UDP daytime client
See the \ref tutdaytime4src \n
Return to the \ref tutindex \n
Go back to \ref tutdaytime3 \n
Go on to \ref tutdaytime5
See the \ref tutdaytime4src "full source listing" \n
Return to the \ref tutindex "tutorial index" \n
Previous: \ref tutdaytime3 \n
Next: \ref tutdaytime5
*/
@ -89,10 +89,10 @@ Return to \ref tutdaytime4
/**
\page tutdaytime5 Tutorial Daytime.5 - A synchronous UDP daytime server
See the \ref tutdaytime5src \n
Return to the \ref tutindex \n
Go back to \ref tutdaytime4 \n
Go on to \ref tutdaytime6
See the \ref tutdaytime5src "full source listing" \n
Return to the \ref tutindex "tutorial index" \n
Previous: \ref tutdaytime4 \n
Next: \ref tutdaytime6
*/
@ -131,10 +131,10 @@ socket->async_sendto(send_buf, send_length, *remote_address,
The <tt>handle_recvfrom()</tt> functions's <tt>bytes_recvd</tt> parameter can
be similarly removed.
See the \ref tutdaytime6src \n
Return to the \ref tutindex \n
Go back to \ref tutdaytime5 \n
Go on to \ref tutdaytime7
See the \ref tutdaytime6src "full source listing" \n
Return to the \ref tutindex "tutorial index" \n
Previous: \ref tutdaytime5 \n
Next: \ref tutdaytime7
*/
@ -147,9 +147,9 @@ Return to \ref tutdaytime6
/**
\page tutdaytime7 Tutorial Daytime.7 - A combined TCP/UDP asynchronous server
See the \ref tutdaytime7src \n
Return to the \ref tutindex \n
Go back to \ref tutdaytime6
See the \ref tutdaytime7src "full source listing" \n
Return to the \ref tutindex "tutorial index" \n
Previous: \ref tutdaytime6
*/

2
asio/src/examples/tutorial/index_dox.txt
View File

@ -1,5 +1,5 @@
/**
\page tutindex Tutorial Index
\page tutindex asio Tutorials
\section tuttimer Basic Skills

28
asio/src/examples/tutorial/timer_dox.txt
View File

@ -43,9 +43,9 @@ message to show when the timer has expired.
\until }
See the \ref tuttimer1src \n
Return to the \ref tutindex \n
Go on to \ref tuttimer2
See the \ref tuttimer1src "full source listing" \n
Return to the \ref tutindex "tutorial index" \n
Next: \ref tuttimer2
*/
@ -101,10 +101,10 @@ consequently asio::demuxer::run() would have returned immediately.
\skip run
\until }
See the \ref tuttimer2src \n
Return to the \ref tutindex \n
Go back to \ref tuttimer1 \n
Go on to \ref tuttimer3
See the \ref tuttimer2src "full source listing" \n
Return to the \ref tutindex "tutorial index" \n
Previous: \ref tuttimer1 \n
Next: \ref tuttimer3
*/
@ -184,10 +184,10 @@ value.
\until }
See the \ref tuttimer3src \n
Return to the \ref tutindex \n
Go back to \ref tuttimer2 \n
Go on to \ref tuttimer4
See the \ref tuttimer3src "full source listing" \n
Return to the \ref tutindex "tutorial index" \n
Previous: \ref tuttimer2 \n
Next: \ref tuttimer4
*/
@ -247,9 +247,9 @@ normal.
\until }
See the \ref tuttimer4src \n
Return to the \ref tutindex \n
Go back to \ref tuttimer3 \n
See the \ref tuttimer4src "full source listing" \n
Return to the \ref tutindex "tutorial index" \n
Previous: \ref tuttimer3 \n
*/