Please add Documentation

nemasu / asmttpd

Web server for Linux written in amd64 assembly.

GNU General Public License v2.0

3.03k stars 199 forks source link

Please add Documentation #44

Closed CSDUMMI closed 3 years ago

CSDUMMI commented 5 years ago

The whole Project has no single Documentation File besides README and Comments in the Source Code. I want to understand this project, but without Documentation, this task gets even harder.

triforce commented 5 years ago

What documentation do you think is needed?

CSDUMMI commented 5 years ago

I need a description of the important data, functions, etc., if I want to understand the Codebase. The Documentation should answer these questions:

How is this project constructed?
How can you call a function, how can you pass arguments to it?
What does a function do?

And if you don't give any documentation to an assembly language project, you give us, who want to understand your project, almost nothing more than we would get if we reverse engineer a similar project.

nemasu commented 5 years ago

Most if not all functions have a comment associated with it that specifies arguments and return parameter and are named to be descriptive as to their function. I don't really have time to make HTML documentation at the moment. If you have any questions though feel free to ask.