flux icon indicating copy to clipboard operation
flux copied to clipboard

Code documentation and plugin for building

Open mwmitchell opened this issue 11 years ago • 1 comments

Currently, Flux lacks documentation on its code/functions. Because of this, there's no way to build docs dynamically. Any public function/namespace within Flux should be documented with a doc string. Something like marginalia [1] could then be used for publishing docs.

  1. https://github.com/gdeer81/marginalia

mwmitchell avatar Oct 05 '14 18:10 mwmitchell

Codox is another documentation system to checkout: https://github.com/weavejester/codox

mwmitchell avatar Oct 05 '14 19:10 mwmitchell