• Hey Guest! Ever feel like entering a Game Jam, but the time limit is always too much pressure? We get it... You lead a hectic life and dedicating 3 whole days to make a game just doesn't work for you! So, why not enter the GMC SLOW JAM? Take your time! Kick back and make your game over 4 months! Interested? Then just click here!

jsdoc

  1. descrubb

    SOLVED Multiline @description JSDocs (Feather) - Can it be done?

    Hei! Is anyone else having trouble getting multiline @description or @param working for Feather's JSDocs Comments in GML Code? I've looked up and down for how to use multiline @description for GMS2's Feather JSDocs, but I cannot find the answer to my problem anywhere! I've checked the JSDocs...
  2. Daniel Mallett

    GameMaker JsDoc missing tags

    Gamemaker has recently started to allow feathering and has implemented Some JsDoc tags. Are there any plans to expand this feature? I'm hoping GameMaker will become 100% compatible with JsDoc.
  3. Daniel Mallett

    GameMaker The new feathering system

    Just discovered the new feathering system which I am very happy about. I just wanted to know if it would be fair to say the only supported Jsdoc tags are the ones located here JSDoc Script Comments (yoyogames.com) I understand there are many more tags than this. Question. Is there any point...
  4. vonFawks

    GameMaker JSDoc - ALL Feather data types?

    So, the manual only lists a handful. And while they are the most immediately useful, I am curious about other various unlisted types. For instance, through curiosity I figured out it supports "Asset.GMShader" and "Id.Uniform" (neither of which are listed in the manual), correctly accepting them...
  5. WangleLine

    GML How can I assign two input types for a function parameter via JSDoc tags?

    The built-in gamemaker function shown above takes two different types for obj, how would I go about JSDoc-tagging a function of my own with two or more types? I can't seem to find anything on this in the manual, and I've already tried a bunch of things, like typing "{Real, Struct}", or "{Real...
  6. Liminal_Warmth

    Help with Getting Function Descriptions to Show

    Hi All! I searched thoroughly and can't seem to find an answer for this so I apologize if I've missed something obvious, but how do I get function @description tags to show in the information bar? This page implies that the @desc tag should display when I call a function (which would be super...
  7. P

    SOLVED What are the best practices for JSDoc autocompletion for long @param descriptions?

    To clarify on the title, I tend to document my code a fair bit when building APIs. I have the following code: /// @description Frame-update step function for a menu. Callables have access to the current /// menu item struct. /// /// @function...
    • paced
    • Thread
    • Replies: 4
    • Forum: Programming
  8. P

    SOLVED How to Update Function Description and Arguments???

    Hello Everybody, I have met the problem while trying to remake some of my functions in GMS 2.3 . I had 6 different scripts for converting coordinates to isometric like in Shaun Spalding's tutorial. Then I decided to use new feature of GMS 2.3 and collect functions from those 6 scripts into 1...
  9. samspade

    GameMaker Does @func @function actually work?

    Title says it. Does the @func or @function JSDoc Script Comments actually do anything? I've tried both versions with and without spaces, cleaned my build, saved, and restarted, checked preferences (couldn't find any relating to it) and it seems to have no effect. GMS 2 autocompletes my script...
  10. Waldemar Lima

    HTML5 How can i send parameters to GML Script using JS ?

    hello everyone ! i am trying send simple parameters to GML Script using GoogleChrome Console or JavaScript Extension ... I tested all these ways, but none worked ... : GM 2 SCRIPT - /// @function gmcallback_hello(id); /// @description Output "Hello World" to the debug console /// @param...
  11. D

    Question - GML Visual Custom Drag & Drop Functions with named Parameters possible?

    Hi, I currently try to create an easy to use RPG Framework for GMS2. For that I would like to make some scripts that I would be compatible with the Drag & Drop System so that beginners could also use it even if I am a programmer and would not use it myself... I noticed that calling GML/DND...
    • DarklinkFighter
    • Thread
    • Replies: 0
    • Forum: Tech Support
  12. Tsa05

     Suggestion: Add @requires as a JSDoc parameter.

    At present, I stick @requires into scripts that I intend to share whenever one depends on another in a set. It doesn't explicitly hurt anything, but it's also not officially supported in JSDoc Script Comments. If YYG would consider it, there's some benefits: In the short-term, being able to...
  13. B

     Suggestion: TODO syntax

    Just a small suggestion, integrate the JSDoc @todo synatx eg. /// @todo Lorem Ipsum When opening a project is loaded all the TODO syntaxes would be loaded and logged into a console tab at the bottom of the editor that allows you to click on each log to open up a window of the code where the...
    • Big_Macca_101
    • Thread
    • Replies: 3
    • Forum: Tech Support
  14. Alice

    Discussion Suggestion: Create script with JSDoc comment

    Hopefully it's simple enough, and it would save me some time for looking up the manual each time I return to gamedev after a while, having forgotten how JSDoc comments look like, exactly. Every time a script would be created, it wouldn't have empty contents as it has now, but be populated with...
  15. B

    Question - IDE [Suggestion] JSDoc @return

    Just a small suggestion that will have a minor impact but when programming scripts with the JSDoc synatx's, why not add an @return syntax to help simplify programming without other people needing to root around code to work out what sort of value is returned. For example it could be used...
    • Big_Macca_101
    • Thread
    • Replies: 2
    • Forum: Tech Support
  16. csanyk

    Question - Code jsdoc

    According to the Help file article on JSDoc style comments in GML: currently only @description/@desc and @param/@arg/@argument comments are supported. I get that many JSDoc block tags are inapplicable to GML but I could also see a few more that would be nice if we could use: @return why no...
  17. C

    Discussion What about documentation?

    GameMaker Studio 2 has JSDoc integration... Does that mean we can expect in the future to be able to build documentations? Will game maker have a feature to build a help file using the jsdoc in all the various object/scripts ? If so, game maker just became my tool of preference over tons of...
    • CedSharp
    • Thread
    • Replies: 0
    • Forum: Tech Support
Top