Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve the "Javadoc". #56

Closed
ydahhrk opened this issue May 27, 2013 · 1 comment
Closed

Improve the "Javadoc". #56

ydahhrk opened this issue May 27, 2013 · 1 comment
Assignees
@ydahhrk
Milestone
3.2.0

Comments

@ydahhrk
Copy link
Member

ydahhrk commented May 27, 2013

Many function comments are outdated, many functions don't have comments and the doxygen folder has seen better days.
Actually, since the doxygen folder is the first thing that gets outdated, we should probably just provide a doxygen configuration file and ask the user to generate it instead.
@ghost ghost assigned ydahhrk May 27, 2013
ydahhrk added a commit that referenced this issue Dec 10, 2013
@ydahhrk
Four things:
8a83cb8 
- I decided to man up and include Issue #70 in the current milestone. Including
Jool in the LOCAL_OUT chain should not mess anything up.
- Fixed a bug: If the zero fragment offset fragment didn't arrive in the
tolerance time, the fragment deleter timer used to crash the kernel.
- We used to think that the kernel decreased the TTL values, which was an odd
fallacy. Anyway, Jool takes care of that now.
- Finally removed the contents of the doc/ directory, which is a fair first
step to address Issue #56. The generated files still leave a lot to be desired,
though.
@ydahhrk ydahhrk added this to the 3.2.0 milestone Jun 24, 2014
ydahhrk added a commit that referenced this issue Jun 27, 2014
@ydahhrk
Been doing a little #56.
04d73b3 
Explaining the user-to-kernel proto has made me want to refactor it,
so here's the checkpoint.
dhfelix pushed a commit that referenced this issue Aug 20, 2014
Been doing a little #56.
6ca1792 
Explaining the user-to-kernel proto has made me want to refactor it,
so here's the checkpoint. (I just copy-paste what @ydahhrk did in a past commit.)
The next commit will fix all errors here, I need to put special attention in fragments config.
@ydahhrk
Copy link
Member Author

ydahhrk commented Sep 4, 2014

Added a bunch of documentation. Honestly, most of the simpler private routines remain silent, but newcomers should have enough from the header files to chew.

The changes were merged into the master branch; Closing.

@ydahhrk ydahhrk closed this as completed Sep 4, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ydahhrk ydahhrk

Labels
None yet
Projects
None yet
Milestone
3.2.0
Development

No branches or pull requests
1 participant
@ydahhrk