3 ms·

Just not enough info in that readme. A simple example would help a lot - showing input file and output file. It can be the most trivial case (10 line files). I

Just not enough info in that readme. A simple example would help a lot - showing input file and output file. It can be the most trivial case (10 line files). I'm also concerned about a tool which must get updated in time with compilers. That means that there will always be some period where the two are out of sync - and that is unacceptable for any project I've ever worked on.

MontagFTB 8y ago
The tool produces multiple output files for a single input. For example: input: https://raw.githubusercontent.com/stlab/libraries/develop/stlab/copy_on_write.hpp https://raw.githubusercontent.com/stlab/libraries/develop/st... output: https://github.com/stlab/stlab.github.io/tree/master/libraries/stlab2Fcopy_on_write.hpp https://github.com/stlab/stlab.github.io/tree/master/librari... As for updating the tool, it's currently building against the top of the Clang tree. In my experience, there are other elements of one's tooling chain that take a longer time to catch up. (For example, Xcode is only periodically released, and even then is using a version of Clang that is somewhat behind. Something similar could be said for MSVC.) Nothing about the tool is closed-source, so it should be easy for anyone to clone the repository and build it against an updated version of the compiler.
- IshKebab 8y ago
  Your output link just shows a load of JSON to me...
  - MontagFTB 8y ago
    The output files are Markdown-formatted with YAML front-matter. The intent is for these files to be fed into a static site generator, like Jekyll. There are tags that require developers fill in the details, which the tool marks as missing. The tool handles all the structuring of the documentation, leaving the meaty details up to the library producers. Then, when combined with your site's static site layout, the output documentation looks however you'd like it to.
    - IshKebab 8y ago
      I don't see any markdown though. And you should show the html output as an example. (if you want users anyway)
MontagFTB 8y ago
A sample of the kind of documentation it can produce is here: http://stlab.cc/libraries/stlab2Fcopy_on_write.hpp/copy_on_write3CT3E/ http://stlab.cc/libraries/stlab2Fcopy_on_write.hpp/copy_on_w...

MontagFTB 8y ago

The tool produces multiple output files for a single input. For example: input: https://raw.githubusercontent.com/stlab/libraries/develop/stlab/copy_on_write.hpp https://raw.githubusercontent.com/stlab/libraries/develop/st... output: https://github.com/stlab/stlab.github.io/tree/master/libraries/stlab2Fcopy_on_write.hpp https://github.com/stlab/stlab.github.io/tree/master/librari... As for updating the tool, it's currently building against the top of the Clang tree. In my experience, there are other elements of one's tooling chain that take a longer time to catch up. (For example, Xcode is only periodically released, and even then is using a version of Clang that is somewhat behind. Something similar could be said for MSVC.) Nothing about the tool is closed-source, so it should be easy for anyone to clone the repository and build it against an updated version of the compiler.

IshKebab 8y ago
Your output link just shows a load of JSON to me...
- MontagFTB 8y ago
  The output files are Markdown-formatted with YAML front-matter. The intent is for these files to be fed into a static site generator, like Jekyll. There are tags that require developers fill in the details, which the tool marks as missing. The tool handles all the structuring of the documentation, leaving the meaty details up to the library producers. Then, when combined with your site's static site layout, the output documentation looks however you'd like it to.
  - IshKebab 8y ago
    I don't see any markdown though. And you should show the html output as an example. (if you want users anyway)

MontagFTB 8y ago

A sample of the kind of documentation it can produce is here: http://stlab.cc/libraries/stlab2Fcopy_on_write.hpp/copy_on_write3CT3E/ http://stlab.cc/libraries/stlab2Fcopy_on_write.hpp/copy_on_w...