github/meteor
1
1
Fork 0
mirror of https://github.com/meteor/meteor.git synced 2026-05-02 03:01:46 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add link to Wiki, add warning that comments aren't used

Browse Source
This commit is contained in:
Sashko Stubailo
2014-09-23 10:22:11 -07:00
parent cf68cd755f
commit e0b452b5c8
3 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/client/data.js
View File

File diff suppressed because one or more lines are too long

12
tools/compiler.js
View File

@@ -571,6 +571,8 @@ var compileUnibuild = function (unipkg, inputSourceArch, packageLoader,
var readOffset = 0;
/**
* The comments for this class aren't used to generate docs right now.
* The docs live in the GitHub Wiki at: https://github.com/meteor/meteor/wiki/CompileStep-API-for-Build-Plugin-Source-Handlers
* @class CompileStep
* @summary The object passed into Plugin.registerSourceHandler
* @global
@@ -641,8 +643,8 @@ var compileUnibuild = function (unipkg, inputSourceArch, packageLoader,
rootOutputPath: inputSourceArch.pkg.serveRoot,
/**
* XXX What are the possible values for this?
* @summary The architecture for which we are building.
* @summary The architecture for which we are building. Can be "os",
* "web.browser", and "web.cordova".
* @type {String}
* @memberOf CompileStep
* @instance
@@ -750,15 +752,15 @@ var compileUnibuild = function (unipkg, inputSourceArch, packageLoader,
/**
* @summary Add JavaScript code. The code added will only see the
* namespaces imported by this package as runtime dependencies using
* ['api.use'](#PackageAPI-use).
* ['api.use'](#PackageAPI-use). If the file being compiled was added
* with the bare flag, the resulting JavaScript won't be wrapped in a
* closure.
* @param {Object} options
* @param {String} options.path The path at which the JavaScript file
* should be inserted, may not be honored in case of path conflicts.
* @param {String} options.data The code to be added.
* @param {String} options.sourcePath The path that will be used in
* any error messages generated by this file, e.g. `foo.js:4:1: error`.
* @param {String} options.bare Do not wrap this file in a closure,
* exposing its variables to other files in the package.
* @memberOf CompileStep
* @instance
*/

2
tools/unipackage.js
View File

@@ -416,6 +416,8 @@ _.extend(Unipackage.prototype, {
* Examples: `"coffee"`, `"coffee.md"`.
* @param {Function} handler A function that takes one argument,
* a CompileStep object.
*
* Documentation for CompileStep is available [on the GitHub Wiki](https://github.com/meteor/meteor/wiki/CompileStep-API-for-Build-Plugin-Source-Handlers).
* @memberOf Plugin
* @locus Build Plugin
*/