crypto-com / defi-wallet-core-rs

Cross-platform, cross-blockchain wallet library in Rust for DeFi Wallet and other applications.
Other
48 stars 16 forks source link

Problem: Missing cpp library documents for developers #329

Closed damoncro closed 2 years ago

damoncro commented 2 years ago

Last Friday, discussed with @lezzokafka @ricky321q.

The suggestions:

  1. Add source codes examples in comments and export to a draft (markdown/html) first.
  2. Study Rust Doc comments way to generate final cpp documents based on markdown/html templates.
  3. Add Unreal documents in the workflow.
damoncro commented 2 years ago

Suggestions on slack: https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/

damoncro commented 2 years ago

And https://slint-ui.com/releases/0.2.1/docs/cpp/

damoncro commented 2 years ago

https://github.com/TartanLlama/cpp-documentation-example