Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Charlestonsoftware/documentation #775

Closed
wants to merge 2 commits into from

3 participants

Charleston Software Associates Mike van Riel Vasil Rangelov
Charleston Software Associates

Added a doc page for the template::generate command.

Includes a commit for my NetBeans ignores. May want to skip that first commit in the branch, but should not do any harm if it is included.

This is my first attempt at docs, let me know if it is not right or if this is not the preferred method for handling integration.

Charleston Software Associates charlestonsoftware gitignore changes for my netbeans project.
Can probably ignore this, but should not cause any problems if included in the master/dev branch.
eb9c70f
Charleston Software Associates charlestonsoftware Start the template::generate page under for-users/commands. 28a027f
Mike van Riel mvriel commented on the diff
.gitignore
((5 lines not shown))
+.vagrant
+/nbproject/private/
Mike van Riel Owner
mvriel added a note

Can you change this into nbproject so that all netbeans files are excluded?

Vasil Rangelov Collaborator

Mike, I am reminded of something that, ironically enough, I saw through your Twitter:
http://blog.evan.pro/properly-excluding-ide-specific-files-with-git

I use NetBeans too, but despite that, IMHO, it would be better not to include IDE specific ignores, and do them as described there instead.

Mike van Riel Owner
mvriel added a note

I think it is good if people would use that but I am not going to force anyone. As such I wouldn't mind to have IDE specific ignores as it lowers the barrier to submit (aside from my untimely responses :disappointed:

Vasil Rangelov Collaborator

Fair enough...

@charlestonsoftware The ball's in your field. It seems we agree that it's best to remove the NetBeans ignore altogether, but if you think otherwise, we'd still merge this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Mike van Riel
Owner

This is looking great, I am very grateful for help with the documentation!
If you could fix my request then I'd be more than happy to include this

Mike van Riel
Owner

I had to filter the commit with your .gitignore changes but merged the rest. Thank you for contributing to phpDocumentor

Mike van Riel mvriel closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Mar 9, 2013
  1. Charleston Software Associates

    gitignore changes for my netbeans project.

    charlestonsoftware authored
    Can probably ignore this, but should not cause any problems if included in the master/dev branch.
  2. Charleston Software Associates
This page is out of date. Refresh to see the latest.
3  .gitignore
View
@@ -9,4 +9,5 @@ build/*
vendor/*
composer.phar
data/templates/*
-.vagrant
+.vagrant
+/nbproject/private/
Mike van Riel Owner
mvriel added a note

Can you change this into nbproject so that all netbeans files are excluded?

Vasil Rangelov Collaborator

Mike, I am reminded of something that, ironically enough, I saw through your Twitter:
http://blog.evan.pro/properly-excluding-ide-specific-files-with-git

I use NetBeans too, but despite that, IMHO, it would be better not to include IDE specific ignores, and do them as described there instead.

Mike van Riel Owner
mvriel added a note

I think it is good if people would use that but I am not going to force anyone. As such I wouldn't mind to have IDE specific ignores as it lowers the barrier to submit (aside from my untimely responses :disappointed:

Vasil Rangelov Collaborator

Fair enough...

@charlestonsoftware The ball's in your field. It seems we agree that it's best to remove the NetBeans ignore altogether, but if you think otherwise, we'd still merge this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
39 docs/manual/for-users/commands/template_generate.rst
View
@@ -1,8 +1,43 @@
template:generate
=================
+Description
+-----------
+Start a new page template that you can customize to meet your needs.
+
+Usage
+-----
+
+::
+
+ $ phpdoc template:generate -t <target path> --name <template name>
+
+Parameters
+----------
+**-a**
+ The author of the template.
+
+**--author[="..."]**
+ Same as -a.
+
+**--force**
+ ???
+
+**--given-version[="..."]*
+ ???
+
+**--name="..."**
+ The name for the template. Typically lowercase. Possibly with hyphens.
+
+**-t**
+ The target path. The directory where the generated documented will be stored.
+
+**--target[="..."]**
+ Same as -t.
+
+
.. note::
- The contents for this chapter have not been written yet. Why not help us and
+ The contents for this chapter is not complete yet. Why not help us and
contribute it at
- https://github.com/phpDocumentor/phpDocumentor2/tree/develop/docs/manual
+ https://github.com/phpDocumentor/phpDocumentor2/tree/develop/docs/manual
2  nbproject/.gitignore
View
@@ -0,0 +1,2 @@
+/*.properties
+/*.xml
Something went wrong with that request. Please try again.