V70d Params section is not recognized

Monkey Forums/Monkey Bug Reports/V70d Params section is not recognized

MikeHart(Posted 2013) [#1]
It seems that the Params: section inside source files or even in monkeydoc files is not recognized and the content doesn't show up insie the help files.

For an example inisde graphics.monkeydoc

# Function LoadImage:Image(path:String,frameCount:Int=1,flags:Int=Image.DefaultFlags)

Loads an image from path.

The frames of a multi-frame image must be laid out in a single horizontal strip, in which case the width of the image is the width of image file divided by the number of frames, and the height of the image is the height of the image file.

The image must be a PNG or JPEG image format, and must have the three-letter file extension .png or .jpg (not .jpeg). PNGs with alpha transparency channels are supported.

Like all game data, the image file must be saved in your project's .data folder or one of its sub-folders.

If your images contain edge padding, you will need to use one of the padding flags such as XYPadding.

See DefaultFlags for a list of valid image flags.

Params: 

path - the data file path of the image to load, relative to your applications .data folder.

frameCount - the number of frames contained in the image.

flags - image flags.

Links: 

[[Resource paths]], [[File formats]], [[Image.DefaultFlags]], [[Image.GrabImage]]



Looks like this:

Loads an image from path.

The frames of a multi-frame image must be laid out in a single horizontal strip, in which case the width of the image is the width of image file divided by the number of frames, and the height of the image is the height of the image file.

The image must be a PNG or JPEG image format, and must have the three-letter file extension .png or .jpg (not .jpeg). PNGs with alpha transparency channels are supported.

Like all game data, the image file must be saved in your project's .data folder or one of its sub-folders.

If your images contain edge padding, you will need to use one of the padding flags such as XYPadding.

See DefaultFlags for a list of valid image flags.

See also Resource paths, File formats, DefaultFlags, GrabImage



MikeHart(Posted 2013) [#2]
Is the Returns: section surpose to be supported?


MikeHart(Posted 2013) [#3]
Problem still exists in V70e.


marksibly(Posted 2013) [#4]
Params and Returns sections are not currently emitted by the templates (and haven't been for a while now).

They can easily be added back if there's demand, but I wont be doing this at least until I find some time to do another sweep of the docs.