Giter Site home page Giter Site logo

Please add Documentation about asmttpd HOT 3 CLOSED

nemasu avatar nemasu commented on May 17, 2024
Please add Documentation

from asmttpd.

Comments (3)

triforce avatar triforce commented on May 17, 2024

What documentation do you think is needed?

from asmttpd.

CSDUMMI avatar CSDUMMI commented on May 17, 2024

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.

from asmttpd.

nemasu avatar nemasu commented on May 17, 2024

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.

from asmttpd.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.