jhm-ciberman / docs_gm Goto Github PK

The dependency yargs was updated from 13.2.2 to 13.2.4.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

yargs is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

Not sure if it's a bug or just not implemented yet.

As stated, @example seems to ignore and there is no way to do line breaks (even w/ HTML). This makes @example only good for simple single-line examples.

There is no official documentation for the template.json file.

The objective is to create an MD file with the documentation for all the properties for template.json.

The devDependency @types/xml2js was updated from 0.4.3 to 0.4.4.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/xml2js is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

Add RuleNoParamType and RuleNoParamDescription to detect when a param has no Type declaration or no description

it shouldn't be copied.

TODO:

• make a test for it
• solve the bug

The dependency nunjucks was updated from 3.1.3 to 3.1.4.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

nunjucks is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Your Greenkeeper Bot 🌴

Folders with only private scripts are still added in the documentation (but no script is shown)

For example, consider the following:

+ scripts
  + my_folder
    - my_public_script
    - another public script
  + my_other_folder
    - _my_private_script
    - _my_other_private_script

If you generate the documentation with docs_gm generate the folder my_other_folder will be still shown on the documentation page. But no script will be inside the folder since all scripts are private.

The expected behavior should be that the empty folders are removed from the documentation (before rendering the documentation)

Add RuleNoReturns to detect when a script has a return but no documentation for it.

Also, RuleNoReturnsType to detect when a return documentation has no type defined.

Validate docs_gm.json and template.json using JSON Schema

Sorry for posting under issues, wanted to know if this project will support GMS2.3 or if it was abandoned?

Add verbosity level debug option. Example:

docs_gm generate -vvvv

Should be more verbose and print debug messages like:

Rendering page for element: tweenline2 [folder]

The devDependency @types/node was updated from 10.11.0 to 10.11.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/node is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Your Greenkeeper Bot 🌴

This rule should detect if the @description tag has a function signature instaed of the actual function description.

This is because, when you import a GMS1 project into GMS2, the @description tag is filled with the function generated signature.

Add DocScript.signature property that returns the full script(a,b,c) signature.

Example:

<b>{{ script.signature }}</b>

Should render to:

<b>my_script(para, foo, bar);</b>

Add docs_gm-basic as a subtree of docs_gm

Actually, docs_gm does not throw any error if the files are not parsed correctly.

It should throw an error.

Based on my gamemaker usage I have some improvements in mind:

• generate documentation for all scripts in a (gamemaker) folder on a single page,
  with links to subfolders
• ability to set a description / usage text for each folder

I could implement it, but I wanted your opinion :)

btw I really like the work you did here :)

Markdown should be optional, acording to http://usejsdoc.org/plugins-markdown.html

It should be enabled by default, but you should be able to disable it using the docs_gm.json file.

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

• Added the new Node.js version to your .travis.yml

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

Your Greenkeeper Bot 🌴

Consider the following documentation:

/// @description tween_to(target_object, duration, vars);
/// @function tween_to
/// @param target_object
/// @param duration
/// @param vars
/**
 * Creates a new tween that animates the target_object variables to the specified 
 * destination values (from the current values) and returns its index. 
 *   
 *       
 * @param {Object | instance | array of objects or instances or mixed} target_object 
 * Target object whose properties should be affected. The target can be any game maker object.
 * You can also pass an array of objects or instances.
 *         
 * @param {real} duration
 * Duration in seconds (or frames if "useframes" true is set in the vars parameter)
 *         
 * @param {array} vars
 * The special vars array.
 */ 

Actually, docs_gm recognizes 6 arguments: ["target_object", "duration", "vars", "target_object", "duration", "vars"]

Since they have the same name, the proposed solution can be:

• Create an option "combineDuplicateParams" in the ProjectConfig.

  • If true, the arguments with the same name will be merged.
  • If false, it will be added as different arguments.

• Create a validation rule RuleDuplicateParam that detects parameters with duplicated names.

  • If active, and there are duplicate arguments with the same name, it should warn on the console or ignore the script acording to the rule configuration.

Actually, the project root is allways the scripts folder. It would be great if you can start your documentation from a subfolder.

For example, given:

+ scripts
  + inventory_system
    - script1
    - script2
    - ...

the project root normally starts on the "scripts" folder, but it would be great to start on the "inventory_system" folder.

Add asset() helper to auto generate URLs to css/js/image files

Support inline @link tags

https://devdocs.io/jsdoc/tags-inline-link