Coder of Salvation™ — programming / opensource / console / minimal
/ Home Actionscript trace cpu hogs
Advanced git aliases for ninjas
Automatic tracing handdrawn scans into vector images in linux
Avs vjgen an triggercode generator
Bash coffeescript es6 and the curly religion
Clever code toggling
Conditional cron is our friend
Emailing poormans ascii graphs using unix tree
Flexible sql columns for production servers
Githooks the minimist quality assurance tool
Imapmunch easy way to select and parse imap email on the commandline
Javascript errors on productionservers
Javascript memory leaks
Javascript simple plugin system
Looping over array in node red nodejs iteration
Md2x a minimalistic markdown bashscript
Mobile webapps are great
Mysql pagers get more overview
Npm git cloning private bitbucket repository with ssh key on openshift
Shellscript framework make quick bash scripts
Simple bash script to document REST api
Snippy autocompletion for console and browser window manager using bash
Storing retrieving hierarchical trees between php and mysql
Switch coffeescript and javascript in vim like a ninja
The ultimate dataformat for bash is tabular data but how to use it
Typesafe functions and nested variables in php javascript and coffeescript using typesafe
Utilities for xi and sf2 looped instruments to aiff wav
Vim mappingmanager organize your mappings
Xdebug bashscript to profile and debug php
You better use snippets son
Bashscript to document REST api
Problem
Sometimes projects are too tiny for fullblown offline docgenerators (doxygen/phpdoc(tor)) or online services like (I/O mashable or Apigee).
Solution
I was in a creative mood..and made this shellscript which scans php-files for certain REST-related commenttags, and turns it into html.
It's kind of a minimalist startingpoint to get any type of custom documentation generated from sourcecode.
Conclusion
Definately a quickndirty one, but it works for me at least. Its really easy to create/generate/update REST-documentation like this. All information is a central place: the sourcecode. Also its easy to create a pdf-handout for this: just rightclick in your browser -> print -> toPDF. Just keep it in mind as a handy script to include in your doc/buildchain.
Download
Please enable JavaScript to view the comments powered by Disqus.
comments powered by
All rights reserved by Leon van Kammen under this license
Coder of Salvation™ — programming / opensource / console / minimal
