The Wayback Machine - https://web.archive.org/web/20201213194717/https://github.com/DLTcollab/tangle-accelerator/pull/666
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

fix(doc): Improve codebase into Doxygen-friendly #666

Merged
merged 1 commit into from Jul 1, 2020

Conversation

@HowJMay
Copy link
Contributor

@HowJMay HowJMay commented Jun 8, 2020

Some files and parameters are missing from doxygen-generated
documentation. The version name in Dockerfile is bumped.

Some documents under tangle-accelerator didn't meet the standard of
Markdown. However, fenced code block for bash commands, we are always
starting with a $ which doesn't meet the standard of Markdown.

@HowJMay HowJMay added the C-doc label Jun 8, 2020
@HowJMay HowJMay force-pushed the HowJMay:doxygen branch 2 times, most recently from 1fc533d to 2090e47 Jun 8, 2020
@HowJMay HowJMay force-pushed the HowJMay:doxygen branch 7 times, most recently from 2c1ad4b to 11a3b23 Jun 19, 2020
@HowJMay HowJMay marked this pull request as ready for review Jun 23, 2020
@HowJMay HowJMay requested review from marktwtn, YingHan-Chen and splasky and removed request for marktwtn Jun 23, 2020
@HowJMay HowJMay force-pushed the HowJMay:doxygen branch 2 times, most recently from d693c39 to 5678204 Jun 23, 2020
accelerator/core/serializer/ser_helper.h Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@jserv jserv left a comment

Fix conflicts

@HowJMay HowJMay force-pushed the HowJMay:doxygen branch from 5678204 to 0007101 Jun 24, 2020
docs/endpoint.md Outdated Show resolved Hide resolved
@HowJMay HowJMay force-pushed the HowJMay:doxygen branch 2 times, most recently from 5e8b251 to 1650c23 Jun 24, 2020
@jserv
Copy link
Member

@jserv jserv commented Jun 27, 2020

Why did CI pipeline fail?

@HowJMay
Copy link
Contributor Author

@HowJMay HowJMay commented Jun 27, 2020

Why did CI pipeline fail?

The CI process was cancelled by someone else which caused it failed

@HowJMay HowJMay mentioned this pull request Jun 29, 2020
@HowJMay HowJMay force-pushed the HowJMay:doxygen branch 2 times, most recently from aa17542 to 67fb43a Jun 29, 2020
@HowJMay HowJMay force-pushed the HowJMay:doxygen branch 4 times, most recently from 56c4407 to 82ea13f Jun 29, 2020
@@ -16,7 +19,7 @@
#endif

/**
* @file cpu-utils.h
* @file cpuinfo.h

This comment has been minimized.

@jserv

jserv Jun 30, 2020
Member

Should be utils/cpuinfo.h

@HowJMay HowJMay force-pushed the HowJMay:doxygen branch from 82ea13f to 5fb15f7 Jun 30, 2020
Copy link
Member

@jserv jserv left a comment

How about mentioning Doxygen-friendly paramter representation in file CONTRIBUTING.md?

@HowJMay HowJMay force-pushed the HowJMay:doxygen branch from 5fb15f7 to d31f522 Jun 30, 2020
Copy link
Member

@jserv jserv left a comment

Improve the subject of Git commit message. You shall summarize what you changed.

@HowJMay HowJMay force-pushed the HowJMay:doxygen branch from d31f522 to 978d926 Jun 30, 2020
Some files and parameters are missing from doxygen-generated
documentation. The version name in Dockerfile is bumped.

Some documents under tangle-accelerator didn't meet the standard of
Markdown. However, fenced code block for bash commands, we are always
starting with a `$` which doesn't meet the standard of Markdown.
@HowJMay HowJMay force-pushed the HowJMay:doxygen branch from 978d926 to 8cf83e9 Jul 1, 2020
@HowJMay HowJMay requested a review from jserv Jul 1, 2020
@jserv
jserv approved these changes Jul 1, 2020
@HowJMay HowJMay changed the title fix(doc): Include files into Doxygen document fix(doc): Improve codebase into Doxygen-friendly Jul 1, 2020
@splasky
splasky approved these changes Jul 1, 2020
@jserv jserv merged commit fe1fb22 into DLTcollab:develop Jul 1, 2020
12 checks passed
12 checks passed
buildkite/tangle-accelerator-pr/pr Build #3404 passed (11 minutes, 21 seconds)
Details
buildkite/tangle-accelerator-pr/pr/bazel-test-asan Passed (3 minutes, 14 seconds)
Details
buildkite/tangle-accelerator-pr/pr/bazel-test-db-enable-asan Passed (3 minutes, 8 seconds)
Details
buildkite/tangle-accelerator-pr/pr/bazel-test-db-enable-ubsan Passed (2 minutes, 59 seconds)
Details
buildkite/tangle-accelerator-pr/pr/bazel-test-mqtt-enable-asan Passed (3 minutes, 12 seconds)
Details
buildkite/tangle-accelerator-pr/pr/bazel-test-mqtt-enable-tsan Passed (5 minutes, 16 seconds)
Details
buildkite/tangle-accelerator-pr/pr/bazel-test-mqtt-enable-ubsan Passed (3 minutes, 18 seconds)
Details
buildkite/tangle-accelerator-pr/pr/bazel-test-tsan Passed (5 minutes, 25 seconds)
Details
buildkite/tangle-accelerator-pr/pr/bazel-test-ubsan Passed (3 minutes, 15 seconds)
Details
buildkite/tangle-accelerator-pr/pr/code-style Passed (5 seconds)
Details
buildkite/tangle-accelerator-pr/pr/endpoint-legato-app Passed (2 minutes, 22 seconds)
Details
buildkite/tangle-accelerator-pr/pr/endpoint-unit-test Passed (16 seconds)
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 participants
You can’t perform that action at this time.