From bdbd39857bf90c09c408a8db716eb5f8f348ef8b Mon Sep 17 00:00:00 2001 From: Joachim Nilsson Date: Sun, 6 Oct 2019 08:13:38 +0200 Subject: Clean up documentation a bit; URLs, wording, personal details ... Signed-off-by: Joachim Nilsson --- configure.ac | 2 +- doc/libnet_api_footer.html_tmpl | 2 +- doc/libnet_api_main_page.md | 105 ++++++++-------------------------------- include/libnet.h.in | 27 +---------- 4 files changed, 25 insertions(+), 111 deletions(-) diff --git a/configure.ac b/configure.ac index 79fd337..310d680 100644 --- a/configure.ac +++ b/configure.ac @@ -12,7 +12,7 @@ dnl the autotools and libtool should be at least these versions AC_PREREQ([2.69]) LT_PREREQ([2.4.2]) -AC_COPYRIGHT([Copyright 1998 - 2017 The libnet Developer Community]) +AC_COPYRIGHT([Copyright 1998 - 2019 The libnet Developer Community]) AC_MSG_RESULT(Beginning autoconfiguration process for libnet-${PACKAGE_VERSION} ...) AC_PROG_SHELL AC_PROG_SED diff --git a/doc/libnet_api_footer.html_tmpl b/doc/libnet_api_footer.html_tmpl index fe84bde..0ee0ea9 100644 --- a/doc/libnet_api_footer.html_tmpl +++ b/doc/libnet_api_footer.html_tmpl @@ -1,6 +1,6 @@
-Documentation for libnet (version $projectnumber).
+Documentation for libnet (version $projectnumber).
Generated on $date by Doxygen $doxygenversion.
diff --git a/doc/libnet_api_main_page.md b/doc/libnet_api_main_page.md index 9b6ce06..532d2b8 100644 --- a/doc/libnet_api_main_page.md +++ b/doc/libnet_api_main_page.md @@ -1,84 +1,21 @@ -libnet API Documentation {#mainpage} -============================ -1998 - 2017 The libnet Developer Community - - -Content(s) ------ -- [Main Page](index.html) -- Files - - [File List](files.html) - - [Globals](globals.html) -- Stuff - - [Rawsocket Non Sequitur](rawsocket_non_sequitur.html) - - Some Sub-sub-page - - Design Notes - - Hacking - - TODO -- Bindings - - Lua - - [Python](https://github.com/allfro/pylibnet "pylibnet") -- Page -- More Page! - - Me Another Sub-page, yay! -- [TODO](index.html#Topics-TODO) - - -Introduction ------------- - -**Attention:** Most on the stuff on this page is either placeholder text and/or -work in progress. -At best, you should take the content on this page half-serious. -I invite you to help expand/improve it. - -This manual documents the low-level libnet API. **If you're planning to this API -directly, you're signing up for some pain.** Just kidding. (I'm not kidding) - -Although there aren't many up-to-date places to look for libnet information these -days (yet), you still might not want to get started learning about libnet by reading -this document. These pages provide an overview of (some) the internals of libnet -with links to the relevant parts of the code. If you "just want it to work" -or if this is all very new to you, then you should first refer to [these](http://www.yomama.com) -(more or less) separate set of pages. -Be sure to check out the man pages as well. - -The libnet API deliberately lacks most convenient functions. As further explained -in [Design Notes](Design_Notes.html "Design Notes"), those happen behind the -scenes, are left to complementary libraries, higher-level libraries or to -"bindings" such as pcap, Python, Lua, etc. and have features such as ~~object -systems and main loops~~ that allow a much more convenient API. - -The low-level API also contains plenty of clutter to support integration with -arbitrary ~~object systems, languages, main loops~~, and so forth. These features -add a lot of noise to the API that you probably don't care about unless you're -coding a binding. - -For now, and probably never will there be similar docs for libnet's internals. -So if you want to get oriented with the libnet source code (because you're interested -in patching the code for example), you should dive straight into each source file, -read the source and the comments surrounding it, and... just... figure the rest out! -Or ask about it [here](https://github.com/sgeto/libnet/issues "Report bugs"). -If that's something you think you're you can see yourself doing then **Welcome Aboard!** -By the way, it's also a good idea to go through some of the commits to understand -the purpose or aim of whoever had their hands on the source before you. -There will be a "[Hacking](Hacking.html)" section soon that is intended to -guide and assist developers through this adventures journey. - -That is, if I don't lose interest, any hope or my sanity before that. -Just kidding. (I'm not kidding) - -Stay tuned. - -**Last Modified:** *Wed, 26 Apr 2017 02:58:54 +0300* - - -TODO ----- - -- try to make it sound smart -- replace stuff inside ~~ with stuff that is actually true -- call mom and dad -- try to get Inbal back :-( -- re-install Windows -- create a separate "doc" branch and never ever (ever) commit anything relate to it directly to master (lesson learnt) \ No newline at end of file +libnet API Documentation {#mainpage} +==================================== +1998 - 2019 The libnet Developer Community + + +Content(s) +---------- + +- [Main Page](index.html) +- Files + - [File List](files.html) + - [Globals](globals.html) +- Bindings + - [Lua](https://github.com/libnet/libnet-lua) + - [Python](https://github.com/allfro/pylibnet "pylibnet") + + +Introduction +------------ + +This manual documents the low-level libnet API. diff --git a/include/libnet.h.in b/include/libnet.h.in index a99f9ed..592e4f7 100644 --- a/include/libnet.h.in +++ b/include/libnet.h.in @@ -38,30 +38,7 @@ * * @details This section doesn't contain any details about libnet.h. * - * If you're wondering why, then that's mostly because libnet.h isn't - * where the action takes place. In fact, no action at all. Okay, maybe a - * little. But definitely not enough worth a separate man page or a detailed - * description. The real action goes down in some of the other files this file - * includes. - * - * Which probably makes you wonder why, of all libnet*.h headers this file - * includes, only libnet-functions.h and libnet-macros.h are documented. - * My friend, you're not alone in your marveling. - * - * You see, the guy who wrote them (Mike D. Schiffman) is gone, and the guy - * after him (Sam Roberts) didn't had much time left at the end of the day - * after bug fixing the living hell out of the source. - * - * And if you're wondering why the rest of libnet's documentation is either - * full of holes or nonexistent, then (a) good question; and (b) see the - * previous paragraph. - * - * Is this a sinking ship? Well, I can't answer that right now. What I can say - * is that it's just us now. So, "Lets (try to) make libnet great again"! - * - * Sincerely, - * - * Ali Abdulkadir + * For details, see libnet-functions.h and libnet-macros.h */ #ifdef __cplusplus @@ -137,4 +114,4 @@ extern "C" { #endif /* __LIBNET_H */ -/* EOF */ \ No newline at end of file +/* EOF */ -- cgit v1.2.1