Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upAK library documentation #1344
AK library documentation #1344
Comments
|
I've been thinking the same thing, but for source code in general. I like that Serenity code is easy to read and rarely needs comments, but some out-of-the-way documentation could be really nice. Documenting things really helps me to understand them. In the meantime, I would highly recommend using some form of search tool to scan the Serenity libraries. This alias is my talisman:
Usually I will |
This might be what I need and thank you for the tip :D
I think that a simple dictionary like documentation would be doable at this stage. It will contain only the data structures, the general algorithms( e.g quick_sort, binary_search ) and the tools (e.g Bitmap) that are available and should be used when possible. The dictionary can point to the specific source file for further reference. |
In every pull request I make, I end up getting told by @awesomekling to swap a piece of code with an existing one from the AK library. Wouldn't it be cool to have a Doxygen like documentation in which someone can search for something to see if it already exists in AK? I know I can grep the project to see if something exists but a documentation is always useful I think, especially if it documents a C++ standard library replacement . Just a thought :)