Log of autodoc.git/autodoc.xml

1999-04-12

1999-04-12 11:41:17 by Mirar (Pontus Hagland) <pike@sort.mirar.org>

a4d12dd0279b4ce0c85648c073ae53196699d92d (465 lines) (+219/-246) ^{[

Show
| Annotate

]}
Branch: 8.0

doc fix

Rev: src/modules/Image/encodings/any.c:1.7
Rev: src/modules/Image/encodings/bmp.c:1.3
Rev: src/modules/Image/encodings/xbm.c:1.2
Rev: src/modules/Image/encodings/xcf.c:1.5
Rev: src/modules/Image/encodings/xwd.c:1.9
Rev: src/modules/Image/search.c:1.8

2191: this is. Methods: - <ref>decode</ref>, <ref>decode_alpha</ref>, + <ref resolved='predef::Image.ANY.decode'>decode</ref>, <ref resolved='predef::Image.ANY.decode_alpha'>decode_alpha</ref>, <ref resolved='predef::Image.ANY._decode'>_decode</ref> 
2200: <ref resolved='predef::Image'>Image</ref></text></group> </doc> - <docgroup homogen-name='_decode' homogen-type='method'> + <docgroup homogen-type='method'> <method name='_decode'> <returntype> <object>mapping </object></returntype> <arguments><argument name='data'><type><string/></type></argument> </arguments> - + </method><method name='decode'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='data'><type><string/></type></argument> + + </arguments> + </method><method name='decode_alpha'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='data'><type><string/></type></argument> + + </arguments> </method><doc> <text> Tries heuristics to find the correct method
2270: BMP is common in the Windows environment. Simple encoding: - <ref resolved='predef::Image.BMP.encode'>encode</ref> - - Advanced encoding: - <ref>encode_P1</ref>, - <ref>encode_P2</ref>, - <ref>encode_P3</ref>, - <ref>encode_P4</ref>, - <ref>encode_P5</ref>, - <ref>encode_P6</ref> + <ref resolved='predef::Image.BMP.encode'>encode</ref> </text> <group><seealso/><text>
4715: "bg":({bgcolor}), // Background color. Default white "invert":1, // Invert the mask ]) - </pre> + </pre> + </text> <group><note/><text> Throws upon error in data.
4766: <pre> normal options: "name":"xbm_image_name" - The name of the XBM. Defaults to 'image'</pre> + The name of the XBM. Defaults to 'image' + </pre> </text> </doc> </docgroup> </module> <module name='XCF'> - <docgroup homogen-name='__decode' homogen-type='method'> - <method name='__decode'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='data'><type> - <or><string/><mapping/></or></type></argument> - <argument name='mapping|voidoptions'><type> - <object resolved='predef::Image.XCF.__decode'/></type></argument> - - </arguments> - </method><doc> - <text> - Decodes a XCF image to a Image.XCF.GimpImage object. - - <pre>Returned structure reference - </pre> - </text> - - </doc> - </docgroup> - <docgroup homogen-name='_decode' homogen-type='method'> - <method name='_decode'> - <returntype> - <object>mapping </object></returntype> - <arguments><argument name='data'><type> - <or><string/><object resolved='predef::Image.XCF._decode'/></or></type></argument> - <argument name='options'><type> - <or><mapping/><void/></or></type></argument> - - </arguments> - </method><doc> - <text> - Decodes a XCF image to a mapping, with at least an - 'image' and possibly an 'alpha' object. Data is either a XCF image, or - a XCF.GimpImage object structure (as received from __decode) - - <pre> Supported options - ([ - "background":({r,g,b})||Image.color object - "draw_all_layers":1, - Draw invisible layers as well - - "draw_guides":1, - Draw the guides - - "draw_selection":1, - Mark the selection using an overlay - - "ignore_unknown_layer_modes":1 - Do not asume 'Normal' for unknown layer modes. - - "mark_layers":1, - Draw an outline around all (drawn) layers - - "mark_layer_names":Image.font object, - Write the name of all layers using the font object, - - "mark_active_layer":1, - Draw an outline around the active layer - ])</pre> - - </text> - <group><note/><text> - Throws upon error in data. For more information, see Image.XCF.__decode - </text></group> - - </doc> - </docgroup> - <docgroup homogen-name='decode' homogen-type='method'> - <method name='decode'> - <returntype> - <object>object </object></returntype> - <arguments><argument name='data'><type><string/></type></argument> - - </arguments> - </method><doc> - <text> - Decodes a XCF image to a single image object. - - </text> - <group><note/><text> - Throws upon error in data, you will loose quite a lot of - information by doing this. See Image.XCF._decode and Image.XCF.__decode - </text></group> - - </doc> - </docgroup> - <class name='Channel'> - <doc> - <text> - { - string name; - int width; - int height; - int opacity; - int r, g, b; - int tattoo; - Hierarchy image_data; - object parent; - mapping flags = ([]); - array (Parasite) parasites; - } - - </text> - - </doc> - </class> - <class name='GimpImage'> - <doc> - <text> - { - int width; - int height; - int compression; - int type; - int tattoo_state; - float xres = 72.0; - float yres = 72.0; - int res_unit; - Image.colortable colormap; - Image.colortable meta_colormap; - array(Layer) layers = ({}); - array(Channel) channels = ({}); - array(Guide) guides = ({}); - array(Parasite) parasites = ({}); - array(Path) paths = ({}); - - Layer active_layer; - Channel active_channel; - Channel selection; - } - - </text> - - </doc> - </class> - <class name='Guide'> - <doc> - <text> - { - int pos; - int vertical; - } - - </text> - - </doc> - </class> - <class name='Hierarchy'> - <doc> - <text> - { - Image.image img; - Image.image alpha; - int width; - int height; - int bpp; - } - - </text> - - </doc> - </class> - <class name='Layer'> - <doc> - <text> - { - string name; - int opacity; - int type; - int mode; - int tattoo; - mapping flags = ([]); - int width, height; - int xoffset, yoffset; - array (Parasite) parasites; - LayerMask mask; - Hierarchy image; - } - - </text> - - </doc> - </class> - <class name='Parasite'> - <doc> - <text> - { - string name; - int flags; - string data; - } - - </text> - - </doc> - </class> - <class name='Path'> - <doc> - <text> - { - string name; - int ptype; - int tattoo; - int closed; - int state; - int locked; - array (PathPoint) points = ({}); - } - - </text> - - </doc> - </class> - <class name='PathPoint'> - <doc> - <text> - { - int type; - float x; - float y; - } - - - </text> - - </doc> + <docgroup homogen-name='___decode' homogen-type='method'> <method name='___decode'> <returntype>
5098: </doc> </docgroup> - </class> + <docgroup homogen-name='__decode' homogen-type='method'> + <method name='__decode'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='data'><type> + <or><string/><mapping/></or></type></argument> + <argument name='mapping|voidoptions'><type> + <object resolved='predef::Image.XCF.__decode'/></type></argument> + + </arguments> + </method><doc> + <text> + Decodes a XCF image to a Image.XCF.GimpImage object. + + <pre>Returned structure reference + + !class GimpImage + { + int width; + int height; + int compression; + int type; + int tattoo_state; + float xres = 72.0; + float yres = 72.0; + int res_unit; + Image.colortable colormap; + Image.colortable meta_colormap; + array(Layer) layers = ({}); + array(Channel) channels = ({}); + array(Guide) guides = ({}); + array(Parasite) parasites = ({}); + array(Path) paths = ({}); + + Layer active_layer; + Channel active_channel; + Channel selection; + } + + !class Layer + { + string name; + int opacity; + int type; + int mode; + int tattoo; + mapping flags = ([]); + int width, height; + int xoffset, yoffset; + array (Parasite) parasites; + LayerMask mask; + Hierarchy image; + } + + !class Channel + { + string name; + int width; + int height; + int opacity; + int r, g, b; + int tattoo; + Hierarchy image_data; + object parent; + mapping flags = ([]); + array (Parasite) parasites; + } + + !class Hierarchy + { + Image.image img; + Image.image alpha; + int width; + int height; + int bpp; + } + + !class Parasite + { + string name; + int flags; + string data; + } + + + !class Guide + { + int pos; + int vertical; + } + + !class Path + { + string name; + int ptype; + int tattoo; + int closed; + int state; + int locked; + array (PathPoint) points = ({}); + } + + !class PathPoint + { + int type; + float x; + float y; + } + + </pre> + </text> + + </doc> + </docgroup> + <docgroup homogen-name='_decode' homogen-type='method'> + <method name='_decode'> + <returntype> + <object>mapping </object></returntype> + <arguments><argument name='data'><type> + <or><string/><object resolved='predef::Image.XCF._decode'/></or></type></argument> + <argument name='options'><type> + <or><mapping/><void/></or></type></argument> + + </arguments> + </method><doc> + <text> + Decodes a XCF image to a mapping, with at least an + 'image' and possibly an 'alpha' object. Data is either a XCF image, or + a XCF.GimpImage object structure (as received from __decode) + + <pre> Supported options + ([ + "background":({r,g,b})||Image.color object + "draw_all_layers":1, + Draw invisible layers as well + + "draw_guides":1, + Draw the guides + + "draw_selection":1, + Mark the selection using an overlay + + "ignore_unknown_layer_modes":1 + Do not asume 'Normal' for unknown layer modes. + + "mark_layers":1, + Draw an outline around all (drawn) layers + + "mark_layer_names":Image.font object, + Write the name of all layers using the font object, + + "mark_active_layer":1, + Draw an outline around the active layer + ])</pre> + + </text> + <group><note/><text> + Throws upon error in data. For more information, see Image.XCF.__decode + </text></group> + + </doc> + </docgroup> + <docgroup homogen-name='decode' homogen-type='method'> + <method name='decode'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='data'><type><string/></type></argument> + + </arguments> + </method><doc> + <text> + Decodes a XCF image to a single image object. + + </text> + <group><note/><text> + Throws upon error in data, you will loose quite a lot of + information by doing this. See Image.XCF._decode and Image.XCF.__decode + </text></group> + + </doc> + </docgroup> </module> <module name='XFace'> <doc>
5215: XWD is the output format for the xwd program. Simple decoding: - <ref>decode</ref> + <ref resolved='predef::Image.XWD.decode'>decode</ref> Advanced decoding: <ref resolved='predef::Image.XWD._decode'>_decode</ref>
5257: </text></group> <group><seealso/><text> - <ref>decode</ref></text></group> + <ref resolved='predef::Image.XWD.decode'>decode</ref></text></group> </doc> </docgroup> - + <docgroup homogen-name='decode' homogen-type='method'> + <method name='decode'> + <returntype> + <object>object </object></returntype> + <arguments><argument name='data'><type><string/></type></argument> + + </arguments> + </method><doc> + <text> + Simple decodes a XWD image file. + </text> + + </doc> + </docgroup> </module> <module name='color'> <doc>
8895: <group><note/><text> Experimental. <pre> | / - \ - hue= 0 64 128 192 (=red in an hsv image)</pre> + hue= 0 64 128 192 (=red in an hsv image) + </pre> </text></group> <group><seealso/><text> <ref resolved='predef::Image.image.orient'>orient</ref>, <ref resolved='predef::Image.image.orient4'>orient4</ref></text></group>
9647: <group><bugs/><text> 0 should not be set as explained above. </text></group> - <group><seealso/><text> - <ref>match_phase</ref></text></group> + </doc> </docgroup>

autodoc.git/ autodoc.xml

1999-04-12

1999-04-12 11:41:17 by Mirar (Pontus Hagland) <pike@sort.mirar.org>