autodoc.git / modref.xml

version» Context lines:

autodoc.git/modref.xml:1:   <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2018-04-11' version='Pike v8.0.5'> + <manual time-stamp='2018-04-13' version='Pike v8.0.5'>    <dir name='./ignored'>    <file name='./ignored/ignored'>    <chapter number='1' title='ignored'>    <autodoc>   <namespace name=''>   <doc><text><p>Symbols implicitly inherited from the virtual base class.</p>   <p> These symbols exist mainly to simplify implementation of    the corresponding lfuns.</p>   </text><group><seealso/><text><p><ref resolved='lfun::'>lfun::</ref></p>   </text></group></doc>
autodoc.git/modref.xml:140547:   <docgroup homogen-name='Solid' homogen-type='constant'><doc><text><p>Solid color.</p>   </text></doc>   <constant name='Solid'/>   </docgroup>   <docgroup homogen-name='Squares' homogen-type='constant'><doc><text><p>Checkerboard pattern (default).</p>   </text></doc>   <constant name='Squares'/>   </docgroup>   </enum>   </class> - <module name='Sass'> - <docgroup homogen-type='constant'><doc><text><p>Description:</p> - <string><group><value>HTTP_IMPORT_NONE</value><text><p>Default value of <ref>Compiler.http_import</ref>. Prohibits imports over HTTP.</p> - </text></group><group><value>HTTP_IMPORT_GREEDY</value><text><p>Allow imports over HTTP only if the returned content type is -  <tt>text/scss</tt>.</p> - </text></group><group><value>HTTP_IMPORT_ANY</value><text><p>Anything goes.</p> - </text></group></string></text></doc> - <constant name='HTTP_IMPORT_NONE'><type><int/></type></constant> - <constant name='HTTP_IMPORT_GREEDY'><type><int/></type></constant> - <constant name='HTTP_IMPORT_ANY'><type><int/></type></constant> - </docgroup> - <docgroup homogen-name='LIBSASS_VERSION' homogen-type='constant'><doc><text><p>The <tt>libsass</tt> version, as a string, this module was compiled agains.</p> - </text></doc> - <constant name='LIBSASS_VERSION'><type><string/></type></constant> - </docgroup> - <docgroup homogen-type='constant'><doc><text><p>Styling of output. Use as argument to <ref>Compiler.set_output_style()</ref></p> - <string><group><value>STYLE_NESTED</value><text><p>The default setting. The output will look like:</p> - <code><text><p>a { -  property: value; -  other-property: value; } -  a:hover { -  property: value; } -  b { -  property: value; }</p> - </text></code> - </text></group><group><value>STYLE_EXPANDED</value><text><p>Fully expanded output:</p> - <code><text><p>a { -  property: value; -  other-property: value; -  } -  a:hover { -  property: value; -  } -  b { -  property: value; -  }</p> - </text></code> - </text></group><group><value>STYLE_COMPACT</value><text><p>Somewhat minified output:</p> - <code><text><p>a { property: value; other-prop: value } -  a:hover { property: value; } -  b { property: value; }</p> - </text></code> - </text></group><group><value>STYLE_COMPRESSED</value><text><p>Minified output</p> - <code><text><p>a{property:value;other-property:value}a:hover{property:value}b{property:value}</p> - </text></code></text></group></string></text></doc> - <constant name='STYLE_NESTED'><type><int/></type></constant> - <constant name='STYLE_EXPANDED'><type><int/></type></constant> - <constant name='STYLE_COMPACT'><type><int/></type></constant> - <constant name='STYLE_COMPRESSED'><type><int/></type></constant> - </docgroup> - <docgroup homogen-name='libsass_language_version' homogen-type='method'><doc><text><p>Returns the <tt>language</tt> version of Sass this module was compiled against</p> - </text></doc> - <method name='libsass_language_version'> - <arguments/> - <returntype><string/></returntype> - </method> - </docgroup> - <docgroup homogen-name='libsass_version' homogen-type='method'><doc><text><p>Returns the <tt>libsass</tt> version this module was compiled against</p> - </text></doc> - <method name='libsass_version'> - <arguments/> - <returntype><string/></returntype> - </method> - </docgroup> - <docgroup homogen-name='sass2scss_version' homogen-type='method'><doc><text><p>Returns the <tt>sass2scss</tt> version this module was compiled against</p> - </text></doc> - <method name='sass2scss_version'> - <arguments/> - <returntype><string/></returntype> - </method> - </docgroup> - <class name='Api'> - <doc><text><p>Low-level Sass/SCSS compiler.</p> - <p> You probably want to use <ref>Compiler</ref> instead of this class.</p> - </text><group><seealso/><text><p><ref>Compiler</ref></p> - </text></group></doc> - <docgroup homogen-name='compile_string' homogen-type='method'><doc><text><p>Compiles the string <ref resolved='predef::Tools.Sass.Api.compile_string.source'>source</ref> and returns the generated CSS.</p> - </text><group><note/><text><p>If the <ref resolved='predef::Tools.Sass.Api.compile_string.source'>source</ref> contain <tt>@import</tt> directives you have to -  explicitly set the include path via <ref resolved='predef::Tools.Sass.Api.include_path'>include_path</ref>.</p> - </text></group><group><param name='source'/><text><p>The string to compile</p> - </text></group></doc> - <method name='compile_string'> - <arguments><argument name='source'><type><string><min>0</min><max>255</max></string></type></argument></arguments> - <returntype><string><min>0</min><max>255</max></string></returntype> - </method> - </docgroup> - <docgroup homogen-name='include_path' homogen-type='variable'><doc><text><p>The base path of <tt>@import</tt>s. Note! This needs to be set when -  <ref resolved='predef::Tools.Sass.Api.compile_string'>compile_string()</ref> is used.</p> - </text></doc> - <variable name='include_path'><type><string><min>0</min><max>255</max></string></type></variable> - </docgroup> - <docgroup homogen-name='omit_source_map_url' homogen-type='variable'><doc><text><p>Set whether writing the <tt>sourceMappingUrl=#</tt> or not.</p> - </text></doc> - <variable name='omit_source_map_url'><type><object>bool</object></type></variable> - </docgroup> - <docgroup homogen-name='output_style' homogen-type='variable'><doc><text><p>Determines the level of compression on the generated output.</p> - </text><group><seealso/><text><p><ref resolved='predef::Tools.Sass.STYLE_NESTED'>STYLE_NESTED</ref>, <ref resolved='predef::Tools.Sass.STYLE_EXPANDED'>STYLE_EXPANDED</ref>, <ref resolved='predef::Tools.Sass.STYLE_COMPACT'>STYLE_COMPACT</ref> and -  <ref resolved='predef::Tools.Sass.STYLE_COMPRESSED'>STYLE_COMPRESSED</ref>.</p> - </text></group></doc> - <variable name='output_style'><type><int><min>0</min><max>3</max></int></type></variable> - </docgroup> - <docgroup homogen-name='precision' homogen-type='variable'><doc><text><p>Set the precision of fractional numbers. Default is <tt>5</tt>.</p> - </text></doc> - <variable name='precision'><type><int/></type></variable> - </docgroup> - <docgroup homogen-name='source_comments' homogen-type='variable'><doc><text><p>Emit comments in the generated CSS indicating the corresponding source -  line. Default is <tt>false</tt>.</p> - </text></doc> - <variable name='source_comments'><type><object>bool</object></type></variable> - </docgroup> - <docgroup homogen-name='source_map_embed' homogen-type='variable'><doc><text><p>Set whether embedding <tt>sourceMappingUrl=#</tt> as data uri or not.</p> - </text></doc> - <variable name='source_map_embed'><type><object>bool</object></type></variable> - </docgroup> - <docgroup homogen-name='source_map_file' homogen-type='variable'><doc><text><p>Set the path of the source map file.</p> - </text></doc> - <variable name='source_map_file'><type><string><min>0</min><max>255</max></string></type></variable> - </docgroup> - <docgroup homogen-name='source_map_root' homogen-type='variable'><doc><text><p>Set the root path of the source files, relative to where the source.map -  file is written.</p> - </text></doc> - <variable name='source_map_root'><type><string><min>0</min><max>255</max></string></type></variable> - </docgroup> - </class> - </module> +    <module name='Shoot'>   <class name='Test'>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='name' homogen-type='constant'><doc><text><p>The name of the test.</p>   </text></doc>   <constant name='name'><type><string/></type></constant>   </docgroup>   <docgroup homogen-name='perform' homogen-type='method'><doc><text><p>perform() is the function called in the tests,
autodoc.git/modref.xml:142443:   </docgroup>   <docgroup homogen-name='get_id' homogen-type='method'><doc><text><p>Returns the <ref resolved='predef::Web.RDF.Resource'>RDF.Resource</ref> that identifies this RSS resource.</p>   </text></doc>   <method name='get_id'>   <arguments/>   <returntype><object resolved='predef::Web.RDF.Resource'>.RDF.Resource</object></returntype>   </method>   </docgroup>   </class>   </module> + <module name='Sass'> + <docgroup homogen-type='constant'><doc><text><p>Description:</p> + <string><group><value>HTTP_IMPORT_NONE</value><text><p>Default value of <ref>Compiler.http_import</ref>. Prohibits imports over HTTP.</p> + </text></group><group><value>HTTP_IMPORT_GREEDY</value><text><p>Allow imports over HTTP only if the returned content type is +  <tt>text/scss</tt>.</p> + </text></group><group><value>HTTP_IMPORT_ANY</value><text><p>Anything goes.</p> + </text></group></string></text></doc> + <constant name='HTTP_IMPORT_NONE'><type><int/></type></constant> + <constant name='HTTP_IMPORT_GREEDY'><type><int/></type></constant> + <constant name='HTTP_IMPORT_ANY'><type><int/></type></constant> + </docgroup> + <docgroup homogen-name='LIBSASS_VERSION' homogen-type='constant'><doc><text><p>The <tt>libsass</tt> version, as a string, this module was compiled agains.</p> + </text></doc> + <constant name='LIBSASS_VERSION'><type><string/></type></constant> + </docgroup> + <docgroup homogen-type='constant'><doc><text><p>Styling of output. Use as argument to <ref>Compiler.set_output_style()</ref></p> + <string><group><value>STYLE_NESTED</value><text><p>The default setting. The output will look like:</p> + <code><text><p>a { +  property: value; +  other-property: value; } +  a:hover { +  property: value; } +  b { +  property: value; }</p> + </text></code> + </text></group><group><value>STYLE_EXPANDED</value><text><p>Fully expanded output:</p> + <code><text><p>a { +  property: value; +  other-property: value; +  } +  a:hover { +  property: value; +  } +  b { +  property: value; +  }</p> + </text></code> + </text></group><group><value>STYLE_COMPACT</value><text><p>Somewhat minified output:</p> + <code><text><p>a { property: value; other-prop: value } +  a:hover { property: value; } +  b { property: value; }</p> + </text></code> + </text></group><group><value>STYLE_COMPRESSED</value><text><p>Minified output</p> + <code><text><p>a{property:value;other-property:value}a:hover{property:value}b{property:value}</p> + </text></code></text></group></string></text></doc> + <constant name='STYLE_NESTED'><type><int/></type></constant> + <constant name='STYLE_EXPANDED'><type><int/></type></constant> + <constant name='STYLE_COMPACT'><type><int/></type></constant> + <constant name='STYLE_COMPRESSED'><type><int/></type></constant> + </docgroup> + <docgroup homogen-name='libsass_language_version' homogen-type='method'><doc><text><p>Returns the <tt>language</tt> version of Sass this module was compiled against</p> + </text></doc> + <method name='libsass_language_version'> + <arguments/> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='libsass_version' homogen-type='method'><doc><text><p>Returns the <tt>libsass</tt> version this module was compiled against</p> + </text></doc> + <method name='libsass_version'> + <arguments/> + <returntype><string/></returntype> + </method> + </docgroup> + <docgroup homogen-name='sass2scss_version' homogen-type='method'><doc><text><p>Returns the <tt>sass2scss</tt> version this module was compiled against</p> + </text></doc> + <method name='sass2scss_version'> + <arguments/> + <returntype><string/></returntype> + </method> + </docgroup> + <class name='Api'> + <doc><text><p>Low-level Sass/SCSS compiler.</p> + <p> You probably want to use <ref>Compiler</ref> instead of this class.</p> + </text><group><seealso/><text><p><ref>Compiler</ref></p> + </text></group></doc> + <docgroup homogen-name='compile_string' homogen-type='method'><doc><text><p>Compiles the string <ref resolved='predef::Web.Sass.Api.compile_string.source'>source</ref> and returns the generated CSS.</p> + </text><group><note/><text><p>If the <ref resolved='predef::Web.Sass.Api.compile_string.source'>source</ref> contain <tt>@import</tt> directives you have to +  explicitly set the include path via <ref resolved='predef::Web.Sass.Api.include_path'>include_path</ref>.</p> + </text></group><group><param name='source'/><text><p>The string to compile</p> + </text></group></doc> + <method name='compile_string'> + <arguments><argument name='source'><type><string><min>0</min><max>255</max></string></type></argument></arguments> + <returntype><string><min>0</min><max>255</max></string></returntype> + </method> + </docgroup> + <docgroup homogen-name='include_path' homogen-type='variable'><doc><text><p>The base path of <tt>@import</tt>s. Note! This needs to be set when +  <ref resolved='predef::Web.Sass.Api.compile_string'>compile_string()</ref> is used.</p> + </text></doc> + <variable name='include_path'><type><string><min>0</min><max>255</max></string></type></variable> + </docgroup> + <docgroup homogen-name='omit_source_map_url' homogen-type='variable'><doc><text><p>Set whether writing the <tt>sourceMappingUrl=#</tt> or not.</p> + </text></doc> + <variable name='omit_source_map_url'><type><object>bool</object></type></variable> + </docgroup> + <docgroup homogen-name='output_style' homogen-type='variable'><doc><text><p>Determines the level of compression on the generated output.</p> + </text><group><seealso/><text><p><ref resolved='predef::Web.Sass.STYLE_NESTED'>STYLE_NESTED</ref>, <ref resolved='predef::Web.Sass.STYLE_EXPANDED'>STYLE_EXPANDED</ref>, <ref resolved='predef::Web.Sass.STYLE_COMPACT'>STYLE_COMPACT</ref> and +  <ref resolved='predef::Web.Sass.STYLE_COMPRESSED'>STYLE_COMPRESSED</ref>.</p> + </text></group></doc> + <variable name='output_style'><type><int><min>0</min><max>3</max></int></type></variable> + </docgroup> + <docgroup homogen-name='precision' homogen-type='variable'><doc><text><p>Set the precision of fractional numbers. Default is <tt>5</tt>.</p> + </text></doc> + <variable name='precision'><type><int/></type></variable> + </docgroup> + <docgroup homogen-name='source_comments' homogen-type='variable'><doc><text><p>Emit comments in the generated CSS indicating the corresponding source +  line. Default is <tt>false</tt>.</p> + </text></doc> + <variable name='source_comments'><type><object>bool</object></type></variable> + </docgroup> + <docgroup homogen-name='source_map_embed' homogen-type='variable'><doc><text><p>Set whether embedding <tt>sourceMappingUrl=#</tt> as data uri or not.</p> + </text></doc> + <variable name='source_map_embed'><type><object>bool</object></type></variable> + </docgroup> + <docgroup homogen-name='source_map_file' homogen-type='variable'><doc><text><p>Set the path of the source map file.</p> + </text></doc> + <variable name='source_map_file'><type><string><min>0</min><max>255</max></string></type></variable> + </docgroup> + <docgroup homogen-name='source_map_root' homogen-type='variable'><doc><text><p>Set the root path of the source files, relative to where the source.map +  file is written.</p> + </text></doc> + <variable name='source_map_root'><type><string><min>0</min><max>255</max></string></type></variable> + </docgroup> + </class>   </module> -  + </module>   <module name='Yabu'>   <doc><text><p>Yabu is an all purpose transaction database written in pike, used    to store data records associated with a unique key.</p>   </text></doc>   <class name='DB'>   <doc><text><p>A Yabu database instance</p>   </text></doc>   <docgroup homogen-name='_indices' homogen-type='method'><doc><text><p>Return a list of all tables</p>   </text></doc>   <method name='_indices'><modifiers><protected/></modifiers>
autodoc.git/modref.xml:143185:   <module name='_Sass'>   <doc><text><p>Sass is a scripting language that is interpreted into Cascading Style    Sheets (CSS). This module is a glue for <tt>libsass</tt>.</p>   </text><group><seealso/><text><p>SASS <url>http://sass-lang.com/</url></p>   </text></group></doc>   <docgroup homogen-name='' homogen-type='import'>   <import name=''><classname resolved='predef::'>predef::</classname></import>   </docgroup>   <docgroup homogen-name='s8' homogen-type='typedef'><doc><text><p>Shorthand for <tt>string(8bit)</tt></p>   </text></doc> - <typedef name='s8'><type><string><min>0</min><max>255</max></string></type></typedef> + <typedef name='s8'><modifiers><protected/></modifiers><type><string><min>0</min><max>255</max></string></type></typedef>   </docgroup>   <class name='Compiler'>   <doc><text><p>Sass/SCSS compiler.</p> - </text><group><example/><text><code><text><p>Tools.Sass.Compiler compiler = Tools.Sass.Compiler();</p> + </text><group><example/><text><code><text><p>Web.Sass.Compiler compiler = Web.Sass.Compiler();</p>   <p> // Allow for HTTP imports, disallowed by default. -  compiler-&gt;http_import = Tools.Sass.HTTP_IMPORT_ANY;</p> +  compiler-&gt;http_import = Web.Sass.HTTP_IMPORT_ANY;</p>   <p> // Minify the output and create a source map file.    compiler-&gt;set_options(([ -  "output_style" : Tools.Sass.STYLE_COMPRESSED, +  "output_style" : Web.Sass.STYLE_COMPRESSED,    "source_map_file" : "path/to/write/source.map"    ]));</p>   <p> if (mixed e = catch(compiler-&gt;compile_file("input.scss", "output.css"))) {    werror("Failed compiling input.scss to output.css\n");    }</p>   </text></code>   </text></group></doc>   <docgroup homogen-name='check_file_access' homogen-type='variable'><doc><text><p>Should file access be tested right away when paths are set or should that    be left to Sass to handle? The default value is <tt>true</tt>.</p>   </text></doc>