Sublime Forum

ApiGen, php Document generator

#1

For those who write php, and like to use ApiGen to generate documentation, I’ve just released a plugin that will let you do it directly from sublime.
packagecontrol.io/packages/ApiGen

[size=150]Features[/size]
Currently The plugin allows click to run functunallity. Simply right click on any open file, or any filename in the sidebar to access the ApiGen options.

[size=150]Options[/size]

Generate - Takes the clicked on file, and uses its path as a starting point to walk back to the filesystem root. The plugin checks each directory along the way for an apigen.neon file. It will halt it’s walk if it finds a file, and call ApiGen passing the apigen.neon file path as the (–config) option.

Selfupdate - Runs the ApiGen (selfupdate) option, to update the apigen.phar file to the latest revision.

Version - Runs the ApiGen (-v) version option.

Version 1.1 will probably come out this weekend and it will contain more options as well as letting you set-up/override pretty much everything via a config file.

0 Likes

#2

Version 1.1.0 has been released. This release adds the following functionality.

Generate Freeform - Works the same as the Generate option, but the user is prompted to provide additional command line arguments.

Freeform - The user is presented a prompt, and allowed to pass any arguments to ApiGen they wish.

0 Likes