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

Header files documentation #804

Merged
merged 6 commits into from
Apr 24, 2024

Conversation

8nvHHobXJ1KS
Copy link
Contributor

In resume I did:

  • Documentation of all macros in crow/app.h.
  • Documentation of namespace crow.
  • Documentation of namespace crow::websocket.
  • Documentation of crow::App alias.
  • Documentation of crow::SimpleApp alias.
  • Documentation of class sha1::SHA1.
  • Documentation of file crow/app.h.
  • Documentation of file crow/TinySHA1.hpp.

⚠️ Important thing ⚠️

Probably is not ready for production, because some classes (or namespaces) have a TODO body
in documentation. This because I wanna write a better documentation of it in the future

Copy link
Member

@gittiver gittiver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you replace the TODOs with content before merge?

@8nvHHobXJ1KS
Copy link
Contributor Author

Sure. But while I do this, how does look the other docs for you?
I think there are more things to add to the reference anyway

@gittiver
Copy link
Member

Sure. But while I do this, how does look the other docs for you? I think there are more things to add to the reference anyway

Probably, yes. hadn't the time to look deeper into it.
Currently there are some open issues with releases (versioning of documentation, deb packets, new 1.1.1 release).

@gittiver gittiver linked an issue Apr 24, 2024 that may be closed by this pull request
@gittiver gittiver merged commit 4fbd9b4 into CrowCpp:master Apr 24, 2024
6 checks passed
gittiver added a commit that referenced this pull request May 12, 2024
* master: (24 commits)
  Get rid of unnecessary string copies in the the keys() method
  Header files documentation (#804)
  Add option to use Boost.Asio
  add HTTP status 406
  fix: compilation error with libc++
  fix: parse body when unsupported HTTP/2 upgrade is requested
  Add configurable exception handler (#637)
  adds flag to avoid adding blueprints multiple times
  adds a flag to avoid adding static routes multiple times
  adds new tests
  update existing tests
  split the different responsibilities of validate into different functions
  Create dependabot.yml
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Undocummented Macros
2 participants