Comments (5)
Hi @zafar-hussain , looks great, How would you like to proceed with it?
from penguinv.
hi @ihhub,
I looked into this issue, and a few points came up, namely
-
multiple Api descriptions documents : can these be renamed eg., cuda's api_description file as cuda_api_description.md, reason is doxygen parses the directories, it lists all similar named doc together, and causes confusion, or these docs are to be removed.
-
multiple readme.md, same as above. ignore the readme.md in the root, that will stay
-
contributing.md needs a bit to tyding for doxygen
-
should separate issues be raised for for each class documentation, it will be easier to keep track
-
do you have any logo for penguinV, so that it can be used in the docs
-
any preferred format like html, pdf, xml for the docs, or we are to only provide a docfile plus instructions for the user to to generate the docs in their preferred format, using doxygen
cheers
from penguinv.
Hi @zafar-hussain , documentation generation in Doxygen is based on comments in the source code. What previously was done is to update the documentation manually which absolutely not a proper approach. Doxygen allows to generate the documentation automatically.
Doxygen can be also configured which types of tiles to be scanned. I think the first step is to add Doxygen as a part of GitHub Actions pipeline at the least to generate documentation.
Answering your ideas:
- Yes, we can. It makes more sense.
- Readme.MD is picked by Github automatically. We need to see if it's possible to do such.
- Can you explain why? Doxygen is going to scan only the source code files
- It would be a lot of issues. It is better to create one with multiple checkboxes.
- Nope.
- For now just instructions. Once we are going to be close to release we will include it into an archive. Also we can generate these files as a part of GitHub Actions pipeline.
from penguinv.
hi @ihhub
thanks for the reply,
for point 3, I allowed doxygen to parse *.md files too, and it created nice looking help pages from them too,
from penguinv.
Hi @ihhub,
Sorry, I can't work on this project due to lack of time.
Cheers
from penguinv.
Related Issues (20)
- Add a support for TIFF images
- Optimise Bitmap image saving function HOT 2
- Use hardware_concurrency() option for thread pool default number of threads
- Add 32-bit compilation stage for Unix platforms HOT 1
- Multitype image support release HOT 10
- load image from memory? HOT 2
- Unable to debug example projects as image paths are in a different location
- OpenCL warnings are not treated as errors
- Add minimum CUDA and OpenCL version into the documentation and compilation requirements
- Add an option / feature to be able to run only a particular unit or performance test
- Enable PNG and JPEG libraries for macOS build
- Create a separate directory with common code for Visual Studio files
- Do not use relative paths in the code. Rather use include path options for compilers
- Add SonarCloud / SonarQube analysis
- Fix mismatch of licenses in source files and License file
- Add VS project file as well as CMake file in the root of the repository
- Add compilation instructions HOT 2
- Update example applications to be more user friendly
- Add a batch script to update Visual Studio files in relation to installed CUDA version
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from penguinv.