|
Please add Examples in the documetation. |
Doctor Cop
Member #16,833
April 2018
|
I am a beginner in C++ and I have difficulty in understanding the documentation page just because there are not enough examples. I am going to make a YouTube series in allegro and I need them so please help me senpai.:P
|
bamccaig
Member #7,536
July 2006
|
Doctor Cop, there are examples distributed with the source code. If you grep those for a particular function you can find example usage. I agree though that including an example snippet for each function or symbol would greatly benefit the documentation and aid in the popularity of the library. Instead of chasing your tail trying to figure out how the pieces fit together, you could see a minimal example of the dependencies for a particular call to work right on the same page as its reference documentation. Instant click, instantly back to hacking. -- acc.js | al4anim - Allegro 4 Animation library | Allegro 5 VS/NuGet Guide | Allegro.cc Mockup | Allegro.cc <code> Tag | Allegro 4 Timer Example (w/ Semaphores) | Allegro 5 "Winpkg" (MSVC readme) | Bambot | Blog | C++ STL Container Flowchart | Castopulence Software | Check Return Values | Derail? | Is This A Discussion? Flow Chart | Filesystem Hierarchy Standard | Clean Code Talks - Global State and Singletons | How To Use Header Files | GNU/Linux (Debian, Fedora, Gentoo) | rot (rot13, rot47, rotN) | Streaming |
Doctor Cop
Member #16,833
April 2018
|
Thaks for the suggestion.
|
|