Documentation (some files describe not yet committed functions) [skip ci]

Author: davidgraeff

doc/aspect_integration_api.md

@@ -0,0 +1,12 @@
+Aspect Integration API
+======================
+[back](../readme.md)
+TODO
+
+You do not have to select any option in cmake as the Aspect-oriented integration way is the default way to build.
+Code-wise you have to provide aspects to cover this functionally:
+* Integrate _IP::init()_ into your initialize routines.
+* Route received network traffic to IPStack::Router() __TODO__.
+* Outgoing traffic can be accessed by an aspect with a pointcut to IPStack::SendBuffer::Send(char* data, int len) __TODO__.
+
+Example: Look at `integration/linux_userspace_with_aspects`.

doc/aspectless_integration_api.md

@@ -0,0 +1,14 @@
+Aspectless Integration API
+==========================
+[back](../readme.md)
+
+In CMake:
+* Select the option __"BUILD_ONLY_LIB"__.
+* If you do not have a multitask system, you also need to check __"BUILD_ONLY_ONE_TASK"__.
+
+Code-wise you have to setup the following:
+* call _IP::init()_ before using any of the ipstack methods.
+* Route traffic received from your network card driver to _IP::receive_from_network(char* data, int len)_.
+* Implement a function for sending to your network card driver and set the function pointer of _IP::send_to_network(char* data, int len)_ accordingly. This is called by the ipstack for outgoing traffic.
+
+Example: Look at `integration/linux_userspace_without_aspects`.

doc/collaborate_index.md

@@ -0,0 +1,3 @@
+Collaborate
+===========
+[back](../readme.md)

doc/cmake_integrate_libipstack.mk renamed to doc/include_in_cmake_based_project.md

@@ -1,5 +1,6 @@
 Integrate libipstack via cmake into your project
 ================================================
+[back](../readme.md)
 
 Use add_subdirectory() to include libipstack in your own CMake based application
 or operating system. You need to provide the kconfig executable either as file in

doc/socket_api.md

@@ -0,0 +1,4 @@
+Aspectless Socket API
+=====================
+[back](../readme.md)
+TODO

libipstack/src/ip/README.md

@@ -0,0 +1,9 @@
+# Direcory "ip"
+This directory contains common IP related code, not specific to IPv4 or IPv6. There is
+common checksumming code, checksum offloading and
+you'll find the single/dual-stack implementation in the subdirectory **dual_single_stack**.
+
+## Management Task
+The IP management task is a collection of background related tasks you need for not user specific traffic generated
+by the IP-Stack. This can be time related tasks like refreshing router table entries or ip specific tasks
+like icmpv4/v6 responses/requests.