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.

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

AK library documentation #1344

Open
marprok opened this issue Mar 3, 2020 · 2 comments
Open

AK library documentation #1344

marprok opened this issue Mar 3, 2020 · 2 comments

Comments

@marprok
Copy link
Contributor

@marprok marprok commented Mar 3, 2020

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 :)

@willmcpherson2
Copy link
Member

@willmcpherson2 willmcpherson2 commented Mar 4, 2020

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.
My only objection is that it might be a little premature. Things are still changing pretty quickly.

In the meantime, I would highly recommend using some form of search tool to scan the Serenity libraries. This alias is my talisman:

alias sg='grep -rnIP --color=auto --exclude-dir=Toolchain --exclude-dir=Root --include=\*.h --include=\*.cpp'

Usually I will sg <PCRE> in Libraries/ to find an API I need or in Applications/ to find usage.

@marprok
Copy link
Contributor Author

@marprok marprok commented Mar 4, 2020

alias sg='grep -rnIP --color=auto --exclude-dir=Toolchain --exclude-dir=Root --include=\*.h --include=\*.cpp'

This might be what I need and thank you for the tip :D

My only objection is that it might be a little premature. Things are still changing pretty quickly.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.