From 9fcf211be6515b09de363baf9cb61253753ec67e Mon Sep 17 00:00:00 2001 From: wiggin77 Date: Thu, 12 Jan 2017 10:03:43 -0500 Subject: [PATCH] README formatting; version bump --- README.md | 20 ++-- package.json | 301 +++++++++++++++++++++++++++------------------------ 2 files changed, 164 insertions(+), 157 deletions(-) diff --git a/README.md b/README.md index 38f26b6..b2a2a7b 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,10 @@ [![Current Version](https://vsmarketplacebadge.apphb.com/version/wiggin77.codedox.svg)](https://marketplace.visualstudio.com/items?itemName=wiggin77.codedox) This is an extension for [Visual Studio Code](https://code.visualstudio.com) that helps developers document their [Haxe](http://haxe.org/) code. -JSDoc style comments can be inserted including automatic generation of `@param` and `@return` tags. File headers can be inserted with customizable -copyright and license comments, or you can choose from a variety of built-in license texts. -This extension is best used as a companion to [vshaxe](https://marketplace.visualstudio.com/items?itemName=nadako.vshaxe) which provides Haxe -support for Visual Studio Code. +JSDoc style comments can be inserted including automatic generation of `@param` and `@return` tags. File headers can be inserted with customizable copyright and license comments, or you can choose from a variety of built-in license texts. + +This extension is best used as a companion to [vshaxe](https://marketplace.visualstudio.com/items?itemName=nadako.vshaxe) which provides Haxe support for Visual Studio Code. ## Usage @@ -16,8 +15,7 @@ support for Visual Studio Code. 2. Position cursor before a function declaration and type `/**` to insert a JSDoc-style comment. 3. Position cursor before a variable or class declaration and type `/**` to get an empty JSDoc-style comment, then press `enter` immediately to get a multiline comment. -File header and JSDoc-style comments can also be inserted using commands. Invoke the commands using `F1` or `Ctrl-Shift-P`/`Cmd-Shift-P` and -typing `Codedox: Insert ...` +File header and JSDoc-style comments can also be inserted using commands. Invoke the commands using `F1` or `Ctrl-Shift-P`/`Cmd-Shift-P` and typing `Codedox: Insert ...` ## Features @@ -32,8 +30,7 @@ typing `Codedox: Insert ...` ## Setup 'Wizard' -A basic configuration can be created using the simple setup 'wizard'. This is triggered when typing `/*` at the top of a file for the first time, -or by running the setup command using `F1` or `Ctrl-Shift-P`/`Cmd-Shift-P` and typing `Codedox: Setup ...`. +A basic configuration can be created using the simple setup 'wizard'. This is triggered when typing `/*` at the top of a file for the first time, or by running the setup command using `F1` or `Ctrl-Shift-P`/`Cmd-Shift-P` and typing `Codedox: Setup ...`. The wizard will ask: 1. Where you want the configuration saved (user or workspace) @@ -48,12 +45,9 @@ The wizard will ask: ## Advanced Configuration -Most Codedox settings are optional, and all required settings can be generated by the setup wizard. If you want use a built-in license template or simple -copyright then just run the setup wizard and skip this section. +Most Codedox settings are optional, and all required settings can be generated by the setup wizard. If you want use a built-in license template or simple copyright then just run the setup wizard and skip this section. -If you want to create a custom license/copyright template or want to change how the comments look, then you can cut and paste the following into your -user or workspace settings file (`.vscode/settings.json`) and customize as needed. A list of built-in parameters that can be used in your custom templates -is also listed below. +If you want to create a custom license/copyright template or want to change how the comments look, then you can cut and paste the following into your user or workspace settings file (`.vscode/settings.json`) and customize as needed. A list of built-in parameters that can be used in your custom templates is also listed below. ```js { diff --git a/package.json b/package.json index cc1c641..69dec08 100644 --- a/package.json +++ b/package.json @@ -1,46 +1,46 @@ { "name": "codedox", - "displayname": "Codedox for Haxe", - "description": "Inserts JSDoc-style comments including @param and @return tags, plus customizable file header license and copyright comments.", - "version": "1.0.0", + "displayname": "Codedox for Haxe", + "description": "Inserts JSDoc-style comments including @param and @return tags, plus customizable file header license and copyright comments.", + "version": "1.2.0", "publisher": "wiggin77", - "license": "(MIT) View license in LICENSE.md", + "license": "(MIT) View license in LICENSE.md", "engines": { "vscode": "^1.4.0" }, - "icon": "images/codedox-logo.png", - "galleryBanner": { - "color": "#A84B38", - "theme": "dark" - }, - "categories": [ - "Other" - ], - "keywords": [ - "Haxe", - "comments", - "JSDoc", - "license", - "copyright" - ], - "bugs": "https://github.com/wiggin77/codedox/issues", - "homepage": "https://github.com/wiggin77/codedox/blob/master/README.md", - "repository": { - "type": "git", - "url": "https://github.com/wiggin77/codedox" - }, + "icon": "images/codedox-logo.png", + "galleryBanner": { + "color": "#A84B38", + "theme": "dark" + }, + "categories": [ + "Other" + ], + "keywords": [ + "Haxe", + "comments", + "JSDoc", + "license", + "copyright" + ], + "bugs": "https://github.com/wiggin77/codedox/issues", + "homepage": "https://github.com/wiggin77/codedox/blob/master/README.md", + "repository": { + "type": "git", + "url": "https://github.com/wiggin77/codedox" + }, "activationEvents": [ "onLanguage:haxe", - "onCommand:codedox.setup", - "onCommand:codedox.fileheader.insert", - "onCommand:codedox.comment.insert" + "onCommand:codedox.setup", + "onCommand:codedox.fileheader.insert", + "onCommand:codedox.comment.insert" ], "main": "./out/codedox", - "scripts": { - "vscode:prepublish": "haxe build.hxml" - }, + "scripts": { + "vscode:prepublish": "haxe build.hxml" + }, "contributes": { - "commands": [ + "commands": [ { "command": "codedox.setup", "title": "Codedox: Setup minimal config" @@ -49,119 +49,132 @@ "command": "codedox.fileheader.insert", "title": "Codedox: Insert file header" }, - { - "command": "codedox.comment.insert", - "title": "Codedox: Insert comment at cursor" - } + { + "command": "codedox.comment.insert", + "title": "Codedox: Insert comment at cursor" + } ], "configuration": { - "type": "object", - "title": "Codedox configuration", - "properties": { - "codedox": { - "description": "Codedox settings.", - "type": "object", - "additionalProperties": false, - "properties": { - "autoInsert": { - "description": "If true then function comment insertion is triggered by typing the value of `commentbegin`", - "type": "boolean", - "default": true - }, - "autoInsertHeader": { - "description": "If true then file header insertion is triggered by typing the value of `headerbegin`", - "type": "boolean", - "default": true - }, - "autoPrefixOnEnter": { - "description": "If true then onEnterRules are added", - "type": "boolean", - "default": true - }, - "neverAskTemplate": { - "description": "If true then never asks to select default template via setup wizard", - "type": "boolean", - "default": false - }, - "commentprefix": { - "description": "Per-line comment prefix", - "type": "string", - "default": "* " - }, - "commentbegin": { - "description": "Start of function comment", - "type": "string", - "default": "/**" - }, - "commentend": { - "description": "End of function comment", - "type": "string", - "default": "*/" - }, - "commentdescription": { - "description": "Initial text added to comment description", - "type": "string", - "default": "[Description]" - }, - "headerprefix": { - "description": "Per-line header prefix", - "type": "string", - "default": " *" - }, - "headerbegin": { - "description": "Start of file header comment", - "type": "string", - "default": "/*" - }, - "headerend": { - "description": "End of file header comment", - "type": "string", - "default": "*/" - }, - "fileheader": { - "description": "Settings for insertFileHeader command", - "type": "object", - "properties": { - "params": { - "description": "Parameters used to populate '${}' fields in a template. Contains groups of params keyed by language id", - "type": "object", - "properties": { - "*": { - "description": "Default params used regardless of which language id is used by the current editor", - "type": "object", - "additionalProperties": { - "oneOf": [ - {"type": "string"}, - {"type": "array", "items": {"type": "string"}} - ] - } - } - }, - "additionalProperties": { - "type": "object", - "additionalProperties": {"type": "string"} - } - }, - "templates": { - "description": "Templates keyed by language id - each template is an array of strings containing text and optional '${}' fields", - "type": "object", - "properties": { - "*": { - "description": "Default template used when no language id specified", - "type": "array", - "items": {"type": "string"} - } - }, - "additionalProperties": { - "type": "array", - "items": {"type": "string"} - } - } - } - } - } - } - } - } + "type": "object", + "title": "Codedox configuration", + "properties": { + "codedox": { + "description": "Codedox settings.", + "type": "object", + "additionalProperties": false, + "properties": { + "autoInsert": { + "description": "If true then function comment insertion is triggered by typing the value of `commentbegin`", + "type": "boolean", + "default": true + }, + "autoInsertHeader": { + "description": "If true then file header insertion is triggered by typing the value of `headerbegin`", + "type": "boolean", + "default": true + }, + "autoPrefixOnEnter": { + "description": "If true then onEnterRules are added", + "type": "boolean", + "default": true + }, + "neverAskTemplate": { + "description": "If true then never asks to select default template via setup wizard", + "type": "boolean", + "default": false + }, + "commentprefix": { + "description": "Per-line comment prefix", + "type": "string", + "default": "* " + }, + "commentbegin": { + "description": "Start of function comment", + "type": "string", + "default": "/**" + }, + "commentend": { + "description": "End of function comment", + "type": "string", + "default": "*/" + }, + "commentdescription": { + "description": "Initial text added to comment description", + "type": "string", + "default": "[Description]" + }, + "headerprefix": { + "description": "Per-line header prefix", + "type": "string", + "default": " *" + }, + "headerbegin": { + "description": "Start of file header comment", + "type": "string", + "default": "/*" + }, + "headerend": { + "description": "End of file header comment", + "type": "string", + "default": "*/" + }, + "fileheader": { + "description": "Settings for insertFileHeader command", + "type": "object", + "properties": { + "params": { + "description": "Parameters used to populate '${}' fields in a template. Contains groups of params keyed by language id", + "type": "object", + "properties": { + "*": { + "description": "Default params used regardless of which language id is used by the current editor", + "type": "object", + "additionalProperties": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ] + } + } + }, + "additionalProperties": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "templates": { + "description": "Templates keyed by language id - each template is an array of strings containing text and optional '${}' fields", + "type": "object", + "properties": { + "*": { + "description": "Default template used when no language id specified", + "type": "array", + "items": { + "type": "string" + } + } + }, + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + } } } \ No newline at end of file