Skip to content

Commit

Permalink
Merge remote-tracking branch 'refs/remotes/origin/development'
Browse files Browse the repository at this point in the history
  • Loading branch information
bdw429s committed Jan 19, 2016
2 parents 72d00cc + c75f3bf commit 3013c42
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 100 deletions.
90 changes: 0 additions & 90 deletions Generate.cfc

This file was deleted.

14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
╚═════╝ ╚═════╝ ╚═════╝╚═════╝ ╚═════╝ ╚═╝ ╚═╝
```

# Welcome to DocBox v2.0.4!
# Welcome to DocBox v2.0.5!

DocBox is a fork of the ColdDoc project originally created by Mark Mandel. Documentation for DocBox can be found on the [GitHub Wiki][1] and in this Readme. The main Git repository and downloads can be found on [GitHub][2]. There is also a help forum located at https://groups.google.com/a/ortussolutions.com/forum/#!forum/docbox

Expand All @@ -19,7 +19,10 @@ Apache License, Version 2.0.
- ColdFusion 10+

## Instructions
You can use DocBox as a standalone application or install it as a CommandBox command via CommandBox: `box install docbox`.
Use the DocBox library to generate API docs from your CFC files. Install Docbox with CommandBox like so:
```bash
box install docbox
```

### Standalone Application
If you want to use DocBox for document generation in your CFML application, then just drop it into any location and create a `/docbox` mapping to it. You will then instantiate the `DocBox` generator class with a `strategy` and `properties` for the strategy.
Expand Down Expand Up @@ -65,8 +68,11 @@ Once the generation finalizes, you will see your beautiful docs!
* `outputFile` : The output file

### CommandBox Command
If installed as a command you will get a new namespace called **docbox** with a **Generate** command. Type `docbox generate help` to see its usage, which is very similar to the instructions above.

There is a related project you can install which wraps up the DocBox libraray in a Custom CLI command so you can generate API docs from the command line.
```bash
box install commandbox-docbox
```
Read more here: https://github.com/Ortus-Solutions/commandbox-docbox

----

Expand Down
10 changes: 4 additions & 6 deletions box.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name":"DocBox",
"version":"2.0.4",
"version":"2.0.5",
"author":"Ortus Solutions, Corp",
"homepage":"http://www.ortussolutions.com",
"documentation":"https://github.com/Ortus-Solutions/DocBox/wiki",
Expand All @@ -11,9 +11,7 @@
"bugs":"https://github.com/Ortus-Solutions/DocBox/issues",
"slug":"docbox",
"shortDescription":"API Documentation generator for ColdFusion (CFML)",
"type":"commandbox-commands",
"createPackageDirectory" : true,
"packageDirectory" : "docbox",
"type":"projects",
"keywords":"apidocs, coldfusion docs, javadocs",
"private":false,
"defaultPort":64492,
Expand All @@ -24,10 +22,10 @@
}
],
"contributors":[

"Brad Wood ([email protected])"
],
"dependencies":{

},
"devDependencies":{

Expand Down
3 changes: 3 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
CHANGELOG
=========

## 2.0.5
* Moved CommandBox command to its own repo

## 2.0.4
* Update package directory and location for CommandBox command

Expand Down

0 comments on commit 3013c42

Please sign in to comment.