Diff of autodoc.git/traditional.xml (ef674c095eacc0be2cca76cbe5707de7edb95de2 » 5a7bb3970c30914dad1aa86722e15383b23c5046)

autodoc.git/traditional.xml:1: <?xml version='1.0' encoding='utf-8'?> - <manual time-stamp='2019-06-21' version='Pike v8.1.13'> + <manual time-stamp='2019-06-22' version='Pike v8.1.13'> <dir name='./traditional_manual'> <file name='./traditional_manual/index.html'> <chapter title='Table of Contents' unnumbered='1'> <dl><dt><url href='index.html'>Table of Contents</url></dt> <dt><url href='chapter_1.html'>1. Introduction</url></dt> <dd><url href='chapter_1.html#1'>1.1. Overview</url></dd> <dd><url href='chapter_1.html#2'>1.2. The history of Pike</url></dd> <dd><url href='chapter_1.html#3'>1.3. A comparison with other languages</url></dd> <dd><url href='chapter_1.html#4'>1.4. What is Pike</url></dd> <dd><url href='chapter_1.html#5'>1.5. Pike License</url></dd>
autodoc.git/traditional.xml:99536: </docgroup> <docgroup homogen-name='get_default_module' homogen-type='method'><doc><text>Get the default module for the current compatibility level (ie typically the value returned by <ref resolved='predef::all_constants'>predef::all_constants()</ref>). The default implementation calls the corresponding function in the master object. </text><group><returns/><text><mixed><group><type><or><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping><object resolved='predef::CompilerEnvironment.get_default_module'/></or></type><text>Constant table to use. </text></group><group><type><int><min>0</min><max>0</max></int></type><text>Use the builtin constant table. </text></group></mixed> </text></group><group><note/><text>This function is typically called by <ref>Pike_compiler()->get_default_module()</ref>. - </text></group><group><seealso/><text><ref resolved='predef::MasterObject.CompatResolver.get_default_module'>MasterObject()->get_default_module()</ref>. + </text></group><group><seealso/><text><ref resolved='predef::CompilationHandler.get_default_module'>MasterObject()->get_default_module()</ref>. </text></group></doc> <method name='get_default_module'> <arguments/> <returntype><or><mapping><indextype><string/></indextype><valuetype><mixed/></valuetype></mapping><object resolved='predef::CompilerEnvironment.get_default_module'/></or></returntype> </method> </docgroup> <docgroup homogen-name='handle_import' homogen-type='method'><doc><text>Look up an import <ref resolved='predef::CompilerEnvironment.handle_import.module'>module</ref>. The default implementation calls the corresponding function in the master object. </text><group><seealso/><text><ref resolved='predef::CompilationHandler.handle_import'>MasterObject()->handle_import()</ref>.
autodoc.git/traditional.xml:142475: <docgroup homogen-name='get_methods' homogen-type='method'><doc><group><returns/><text>A structure describing all available methods on the current wsdl. </text></group></doc> <method name='get_methods'><modifiers><final/></modifiers> <arguments/> <returntype><object>Arguments</object></returntype> </method> </docgroup> </class> </module> <module name='Sass'> + <doc><text>Sass is a scripting language that is interpreted into Cascading Style + Sheets (CSS). This module is a glue for <tt>libsass</tt>. + </text><group><seealso/><text>SASS <url>http://sass-lang.com/</url> + </text></group></doc> <docgroup homogen-type='constant'><doc><text>Description: - <string><group><value>HTTP_IMPORT_NONE</value><text>Default value of <ref>Compiler.http_import</ref>. Prohibits imports over HTTP. + <string><group><value>HTTP_IMPORT_NONE</value><text>Default value of <ref resolved='predef::Web.Sass.Compiler.http_import'>Compiler.http_import</ref>. Prohibits imports over HTTP. </text></group><group><value>HTTP_IMPORT_GREEDY</value><text>Allow imports over HTTP only if the returned content type is <tt>text/scss</tt>. </text></group><group><value>HTTP_IMPORT_ANY</value><text>Anything goes. </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>The <tt>libsass</tt> version, as a string, this module was compiled agains. </text></doc>
autodoc.git/traditional.xml:142524: b { property: value; } </text></code> </text></group><group><value>STYLE_COMPRESSED</value><text>Minified output <code><text>a{property:value;other-property:value}a:hover{property:value}b{property:value} </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='' homogen-type='import'> + <import name=''><classname resolved='predef::'>predef::</classname></import> + </docgroup> <docgroup homogen-name='libsass_language_version' homogen-type='method'><doc><text>Returns the <tt>language</tt> version of Sass this module was compiled against </text></doc> <method name='libsass_language_version'> <arguments/> <returntype><string/></returntype> </method> </docgroup> <docgroup homogen-name='libsass_version' homogen-type='method'><doc><text>Returns the <tt>libsass</tt> version this module was compiled against </text></doc> <method name='libsass_version'> <arguments/> <returntype><string/></returntype> </method> </docgroup> - + <docgroup homogen-name='s8' homogen-type='typedef'><doc><text>Shorthand for <tt>string(8bit)</tt> + </text></doc> + <typedef name='s8'><modifiers><protected/></modifiers><type><string><min>0</min><max>255</max></string></type></typedef> + </docgroup> <docgroup homogen-name='sass2scss' homogen-type='method'><doc><text>Convert Sass syntax (i.e. indented syntax) to SCSS syntax. </text><group><param name='data'/><text>Sass syntax text to convert to SCSS syntax. </text></group><group><param name='options'/><text>This is a bitwise union of compression level (<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 $[STYLE_COMPRESSED]) and the <tt>SASS2SCSS_*</tt> constants <ref>SASS2SCSS_KEEP_COMMENT</ref>, <ref>SASS2SCSS_STRIP_COMMENT</ref> and <ref>SASS2SCSS_CONVERT_COMMENT</ref>. It defaults to <expr>STYLE_NESTED|SASS2SCSS_KEEP_COMMENT</expr>. </text></group><group><returns/><text><ref resolved='predef::Web.Sass.sass2scss.data'>data</ref> converted to SCSS syntax. </text></group></doc> <method name='sass2scss'>
autodoc.git/traditional.xml:142565: </docgroup> <docgroup homogen-name='sass2scss_version' homogen-type='method'><doc><text>Returns the <tt>sass2scss</tt> version this module was compiled against </text></doc> <method name='sass2scss_version'> <arguments/> <returntype><string/></returntype> </method> </docgroup> <class name='Api'> <doc><text>Low-level Sass/SCSS compiler. - You probably want to use <ref>Compiler</ref> instead of this class. - </text><group><seealso/><text><ref>Compiler</ref> + You probably want to use <ref resolved='predef::Web.Sass.Compiler'>Compiler</ref> instead of this class. + </text><group><seealso/><text><ref resolved='predef::Web.Sass.Compiler'>Compiler</ref> </text></group></doc> <docgroup homogen-name='compile_string' homogen-type='method'><doc><text>Compiles the string <ref resolved='predef::Web.Sass.Api.compile_string.source'>source</ref> and returns the generated CSS. </text><group><param name='source'/><text>The string to compile </text></group><group><returns/><text>A mapping with the generated CSS and source mapping file if such is set to be generated <mapping><group><member><type><string><min>0</min><max>255</max></string></type><index>"css"</index></member><text>The generated CSS </text></group><group><member><type><string><min>0</min><max>255</max></string></type><index>"map"</index></member><text>The generated source mapping data </text></group></mapping> </text></group><group><note/><text>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>.
autodoc.git/traditional.xml:142626: <docgroup homogen-name='source_map_file' homogen-type='variable'><doc><text>Set the path of the source map file. </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>Set the root path of the source files, relative to where the source.map file is written. </text></doc> <variable name='source_map_root'><type><string><min>0</min><max>255</max></string></type></variable> </docgroup> </class> + <class name='Compiler'> + <doc><text>Sass/SCSS compiler. + </text><group><example/><text><code><text>Web.Sass.Compiler compiler = Web.Sass.Compiler(); + // Allow for HTTP imports, disallowed by default. + compiler->http_import = Web.Sass.HTTP_IMPORT_ANY; + // Minify the output and create a source map file. + compiler->set_options(([ + "output_style" : Web.Sass.STYLE_COMPRESSED, + "source_map_file" : "path/to/write/source.map" + ])); + if (mixed e = catch(compiler->compile_file("input.scss", "output.css"))) { + werror("Failed compiling input.scss to output.css\n"); + } + </text></code> + </text></group></doc> + <docgroup homogen-name='check_file_access' homogen-type='variable'><doc><text>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>. + </text></doc> + <variable name='check_file_access'><modifiers><public/></modifiers><type><object resolved='predef::bool'>bool</object></type></variable> + </docgroup> + <docgroup homogen-name='compile_file' homogen-type='method'><doc><text>Compile the file <ref resolved='predef::Web.Sass.Compiler.compile_file.input_file'>input_file</ref> and return the result + </text><group><param name='input_file'/><text>The SCSS file to compile + </text></group><group><returns/><text>A mapping with the generated CSS and source mapping file if such is + set to be generated + <mapping><group><member><type><string><min>0</min><max>255</max></string></type><index>"css"</index></member><text>The generated CSS + </text></group><group><member><type><string><min>0</min><max>255</max></string></type><index>"map"</index></member><text>The generated source mapping data + </text></group></mapping> + </text></group></doc> + <method name='compile_file'> + <arguments><argument name='input_file'><type><object resolved='predef::Web.Sass.s8'>s8</object></type></argument></arguments> + <returntype><mapping><indextype><object resolved='predef::Web.Sass.s8'>s8</object></indextype><valuetype><object resolved='predef::Web.Sass.s8'>s8</object></valuetype></mapping></returntype> + </method> + </docgroup> + <docgroup homogen-name='compile_file' homogen-type='method'><doc><text>Compile the file <ref resolved='predef::Web.Sass.Compiler.compile_file.input_file'>input_file</ref> and write the result to <ref resolved='predef::Web.Sass.Compiler.compile_file.output_file'>output_file</ref>. + If a source mapping file is set to be generated either via + <ref resolved='predef::Web.Sass.Compiler.set_options'>set_options()</ref> or <ref resolved='predef::Web.Sass.Api.source_map_file'>source_map_file</ref> it will be written as per + the value set in the option. + </text><group><param name='input_file'/><text>The SCSS file to compile + </text></group><group><param name='output_file'/><text>The name of the CSS file to save the result in. + </text></group></doc> + <method name='compile_file'><modifiers><variant/></modifiers> + <arguments><argument name='input_file'><type><object resolved='predef::Web.Sass.s8'>s8</object></type></argument><argument name='output_file'><type><object resolved='predef::Web.Sass.s8'>s8</object></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + <docgroup homogen-name='handle_sass_import' homogen-type='method'><doc><text>Resolve imports in sass/scss files. + </text><group><note/><text>In general this method doesn't need to overloaded. In principle it's + only necessary if the Sass files reside in a non-standard filesystem. + </text></group><group><note/><text>If overloaded <ref>abs_path</ref> and <ref>rel_path</ref> is the absolute and relaive + paths of the file containing the import statement <ref resolved='predef::Web.Sass.Compiler.handle_sass_import.path'>path</ref>. + If the Sass/SCSS files are located in a normal filesystem this method + can return the contents of <ref resolved='predef::Web.Sass.Compiler.handle_sass_import.path'>path</ref> as a string and <tt>libsass</tt> will + resolve the paths to the imports by itself. + However, if the files are not located in a normal filesystem this + function should return an array of two indices, where the first index + should be the contents of <ref resolved='predef::Web.Sass.Compiler.handle_sass_import.path'>path</ref> and the second the calculated absolute + path of <ref resolved='predef::Web.Sass.Compiler.handle_sass_import.path'>path</ref>. + </text></group><group><param name='path'/><text>This is the value of `path` in <tt>@import 'path'</tt>. + </text></group><group><param name='absolute_path'/><text>This is the absolute path of the file containing the <tt>@import</tt> + statement. + </text></group><group><param name='relative_path'/><text>The relative path of <ref resolved='predef::Web.Sass.Compiler.handle_sass_import.absolute_path'>absolute_path</ref> in relation to the prevoius + <ref resolved='predef::Web.Sass.Compiler.handle_sass_import.absolute_path'>absolute_path</ref> + </text></group><group><returns/><text><mixed><group><type><int><min>0</min><max>0</max></int></type><text>If undefined is returned the import resolution is given back to + <tt>libsass</tt>. + </text></group><group><type><string><min>0</min><max>255</max></string></type><text>The contents of <ref resolved='predef::Web.Sass.Compiler.handle_sass_import.path'>path</ref> + </text></group><group><type><array><valuetype><string><min>0</min><max>255</max></string></valuetype></array></type><text>if an array is returned it should contain two indices, where the first + if the contents of <ref resolved='predef::Web.Sass.Compiler.handle_sass_import.path'>path</ref> and the second should be the absolute path + <ref resolved='predef::Web.Sass.Compiler.handle_sass_import.path'>path</ref>. This is only useful (needed) if the Sass files doesn't + reside in a normal filesystem that <tt>libsass</tt> can read. + </text></group></mixed> + </text></group></doc> + <method name='handle_sass_import'><modifiers><protected/></modifiers> + <arguments><argument name='path'><type><string><min>0</min><max>255</max></string></type></argument><argument name='absolute_path'><type><or><void/><string><min>0</min><max>255</max></string></or></type></argument><argument name='relative_path'><type><or><void/><string><min>0</min><max>255</max></string></or></type></argument></arguments> + <returntype><or><string/><array><valuetype><string><min>0</min><max>255</max></string></valuetype></array></or></returntype> + </method> + </docgroup> + <docgroup homogen-name='http_import' homogen-type='variable'><doc><text>If a Sass file is importing an external URI this flag determines if + thats allowed at all, or if the content type of the imported file has + to be in <ref resolved='predef::Web.Sass.Compiler.http_import_allow_ct'>http_import_allow_ct</ref>, or if anything goes. + Default is <ref resolved='predef::Web.Sass.HTTP_IMPORT_NONE'>HTTP_IMPORT_NONE</ref>. + </text><group><seealso/><text><ref resolved='predef::Web.Sass.HTTP_IMPORT_NONE'>HTTP_IMPORT_NONE</ref>, <ref resolved='predef::Web.Sass.HTTP_IMPORT_GREEDY'>HTTP_IMPORT_GREEDY</ref> and + <ref resolved='predef::Web.Sass.HTTP_IMPORT_ANY'>HTTP_IMPORT_ANY</ref>. + </text></group></doc> + <variable name='http_import'><modifiers><public/></modifiers><type><int><min>0</min><max>2</max></int></type></variable> + </docgroup> + <docgroup homogen-name='http_import_allow_ct' homogen-type='variable'><doc><text>List of allowed content types if <ref resolved='predef::Web.Sass.Compiler.http_import'>http_import</ref> is set to + <ref resolved='predef::Web.Sass.HTTP_IMPORT_GREEDY'>HTTP_IMPORT_GREEDY</ref>. The default is to allow <tt>text/scss</tt> and + <tt>text/sass</tt>. + </text></doc> + <variable name='http_import_allow_ct'><modifiers><public/></modifiers><type><multiset><indextype><object resolved='predef::Web.Sass.s8'>s8</object></indextype></multiset></type></variable> + </docgroup> + <docgroup homogen-name='Api' homogen-type='inherit'> + <inherit name='Api'><classname resolved='predef::Web.Sass.Api'>Api</classname></inherit> + </docgroup> + <docgroup homogen-name='set_options' homogen-type='method'><doc><text>Set options to the SASS compiler. + </text><group><param name='opts'/><text><mapping><group><member><type><int/></type><index>"output_style"</index></member><text>Any of the <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> + or <ref resolved='predef::Web.Sass.STYLE_COMPRESSED'>STYLE_COMPRESSED</ref> constants. See also <ref resolved='predef::Web.Sass.Api.output_style'>output_style</ref>. + </text></group><group><member><type><string><min>0</min><max>255</max></string></type><index>"include_path"</index></member><text>Path to root of incude files. See also <ref resolved='predef::Web.Sass.Api.include_path'>include_path</ref>. + </text></group><group><member><type><string><min>0</min><max>255</max></string></type><index>"source_map_file"</index></member><text>File to write source map file to. + See also <ref resolved='predef::Web.Sass.Api.source_map_file'>source_map_file</ref>. + </text></group><group><member><type><object resolved='predef::bool'>bool</object></type><index>"source_comments"</index></member><text>Turn on/off comments in the output containing info about the source + file - line numbers and such. Default of <tt>false</tt>. See also + <ref resolved='predef::Web.Sass.Api.source_comments'>source_comments</ref>. + </text></group><group><member><type><object resolved='predef::bool'>bool</object></type><index>"source_map_embed"</index></member><text>Turn on/off if a source map should be embedded in the output or not. + Default is <tt>false</tt>. See also <ref resolved='predef::Web.Sass.Api.source_map_embed'>source_map_embed</ref>. + </text></group><group><member><type><string><min>0</min><max>255</max></string></type><index>"source_map_root"</index></member><text>Set the root path of the source files, relative to where the + source.map file is written. + See also <ref resolved='predef::Web.Sass.Api.source_map_root'>source_map_root</ref> + </text></group><group><member><type><object resolved='predef::bool'>bool</object></type><index>"omit_source_map_url"</index></member><text>Omit the #sourceMappingURL or not. + See also <ref resolved='predef::Web.Sass.Api.omit_source_map_url'>omit_source_map_url</ref> + </text></group><group><member><type><object resolved='predef::bool'>bool</object></type><index>"sass_syntax"</index></member><text>Turn on/off Sass syntax, i.e. indented syntax. Only necessary when + using <ref resolved='predef::Web.Sass.Api.compile_string'>compile_string()</ref> + </text></group><group><member><type><int/></type><index>"precision"</index></member><text>Floating point precision. See also <ref resolved='predef::Web.Sass.Api.precision'>precision</ref>. + </text></group></mapping> + </text></group></doc> + <method name='set_options'> + <arguments><argument name='opts'><type><mapping><indextype><object resolved='predef::Web.Sass.s8'>s8</object></indextype><valuetype><or><object resolved='predef::Web.Sass.s8'>s8</object><int/></or></valuetype></mapping></type></argument></arguments> + <returntype><void/></returntype> + </method> + </docgroup> + </class> </module> <module name='SocketIO'> <doc><text>This is an implementation of the Socket.IO server-side communication's driver. It basically is a real-time bidirectional object-oriented communication's protocol for communicating between a webbrowser and a server. This module supports the following features: <ul><group><item/><text>Passing any arbitrarily deep nested data object which can be represented in basic JavaScript datatypes. </text></group><group><item/><text>In addition to the normal JavaScript datatypes, it also
autodoc.git/traditional.xml:143238: </module> - <module name='_Sass'> - <doc><text>Sass is a scripting language that is interpreted into Cascading Style - Sheets (CSS). This module is a glue for <tt>libsass</tt>. - </text><group><seealso/><text>SASS <url>http://sass-lang.com/</url> - </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>Shorthand for <tt>string(8bit)</tt> - </text></doc> - <typedef name='s8'><modifiers><protected/></modifiers><type><string><min>0</min><max>255</max></string></type></typedef> - </docgroup> - <class name='Compiler'> - <doc><text>Sass/SCSS compiler. - </text><group><example/><text><code><text>Web.Sass.Compiler compiler = Web.Sass.Compiler(); - // Allow for HTTP imports, disallowed by default. - compiler->http_import = Web.Sass.HTTP_IMPORT_ANY; - // Minify the output and create a source map file. - compiler->set_options(([ - "output_style" : Web.Sass.STYLE_COMPRESSED, - "source_map_file" : "path/to/write/source.map" - ])); - if (mixed e = catch(compiler->compile_file("input.scss", "output.css"))) { - werror("Failed compiling input.scss to output.css\n"); - } - </text></code> - </text></group></doc> - <docgroup homogen-name='check_file_access' homogen-type='variable'><doc><text>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>. - </text></doc> - <variable name='check_file_access'><modifiers><public/></modifiers><type><object resolved='predef::bool'>bool</object></type></variable> - </docgroup> - <docgroup homogen-name='compile_file' homogen-type='method'><doc><text>Compile the file <ref resolved='predef::_Sass.Compiler.compile_file.input_file'>input_file</ref> and return the result - </text><group><param name='input_file'/><text>The SCSS file to compile - </text></group><group><returns/><text>A mapping with the generated CSS and source mapping file if such is - set to be generated - <mapping><group><member><type><string><min>0</min><max>255</max></string></type><index>"css"</index></member><text>The generated CSS - </text></group><group><member><type><string><min>0</min><max>255</max></string></type><index>"map"</index></member><text>The generated source mapping data - </text></group></mapping> - </text></group></doc> - <method name='compile_file'> - <arguments><argument name='input_file'><type><object resolved='predef::_Sass.s8'>s8</object></type></argument></arguments> - <returntype><mapping><indextype><object resolved='predef::_Sass.s8'>s8</object></indextype><valuetype><object resolved='predef::_Sass.s8'>s8</object></valuetype></mapping></returntype> - </method> - </docgroup> - <docgroup homogen-name='compile_file' homogen-type='method'><doc><text>Compile the file <ref resolved='predef::_Sass.Compiler.compile_file.input_file'>input_file</ref> and write the result to <ref resolved='predef::_Sass.Compiler.compile_file.output_file'>output_file</ref>. - If a source mapping file is set to be generated either via - <ref resolved='predef::_Sass.Compiler.set_options'>set_options()</ref> or <ref>source_map_file</ref> it will be written as per - the value set in the option. - </text><group><param name='input_file'/><text>The SCSS file to compile - </text></group><group><param name='output_file'/><text>The name of the CSS file to save the result in. - </text></group></doc> - <method name='compile_file'><modifiers><variant/></modifiers> - <arguments><argument name='input_file'><type><object resolved='predef::_Sass.s8'>s8</object></type></argument><argument name='output_file'><type><object resolved='predef::_Sass.s8'>s8</object></type></argument></arguments> - <returntype><void/></returntype> - </method> - </docgroup> - <docgroup homogen-name='handle_sass_import' homogen-type='method'><doc><text>Resolve imports in sass/scss files. - </text><group><note/><text>In general this method doesn't need to overloaded. In principle it's - only necessary if the Sass files reside in a non-standard filesystem. - </text></group><group><note/><text>If overloaded <ref>abs_path</ref> and <ref>rel_path</ref> is the absolute and relaive - paths of the file containing the import statement <ref resolved='predef::_Sass.Compiler.handle_sass_import.path'>path</ref>. - If the Sass/SCSS files are located in a normal filesystem this method - can return the contents of <ref resolved='predef::_Sass.Compiler.handle_sass_import.path'>path</ref> as a string and <tt>libsass</tt> will - resolve the paths to the imports by itself. - However, if the files are not located in a normal filesystem this - function should return an array of two indices, where the first index - should be the contents of <ref resolved='predef::_Sass.Compiler.handle_sass_import.path'>path</ref> and the second the calculated absolute - path of <ref resolved='predef::_Sass.Compiler.handle_sass_import.path'>path</ref>. - </text></group><group><param name='path'/><text>This is the value of `path` in <tt>@import 'path'</tt>. - </text></group><group><param name='absolute_path'/><text>This is the absolute path of the file containing the <tt>@import</tt> - statement. - </text></group><group><param name='relative_path'/><text>The relative path of <ref resolved='predef::_Sass.Compiler.handle_sass_import.absolute_path'>absolute_path</ref> in relation to the prevoius - <ref resolved='predef::_Sass.Compiler.handle_sass_import.absolute_path'>absolute_path</ref> - </text></group><group><returns/><text><mixed><group><type><int><min>0</min><max>0</max></int></type><text>If undefined is returned the import resolution is given back to - <tt>libsass</tt>. - </text></group><group><type><string><min>0</min><max>255</max></string></type><text>The contents of <ref resolved='predef::_Sass.Compiler.handle_sass_import.path'>path</ref> - </text></group><group><type><array><valuetype><string><min>0</min><max>255</max></string></valuetype></array></type><text>if an array is returned it should contain two indices, where the first - if the contents of <ref resolved='predef::_Sass.Compiler.handle_sass_import.path'>path</ref> and the second should be the absolute path - <ref resolved='predef::_Sass.Compiler.handle_sass_import.path'>path</ref>. This is only useful (needed) if the Sass files doesn't - reside in a normal filesystem that <tt>libsass</tt> can read. - </text></group></mixed> - </text></group></doc> - <method name='handle_sass_import'><modifiers><protected/></modifiers> - <arguments><argument name='path'><type><string><min>0</min><max>255</max></string></type></argument><argument name='absolute_path'><type><or><void/><string><min>0</min><max>255</max></string></or></type></argument><argument name='relative_path'><type><or><void/><string><min>0</min><max>255</max></string></or></type></argument></arguments> - <returntype><or><string/><array><valuetype><string><min>0</min><max>255</max></string></valuetype></array></or></returntype> - </method> - </docgroup> - <docgroup homogen-name='http_import' homogen-type='variable'><doc><text>If a Sass file is importing an external URI this flag determines if - thats allowed at all, or if the content type of the imported file has - to be in <ref resolved='predef::_Sass.Compiler.http_import_allow_ct'>http_import_allow_ct</ref>, or if anything goes. - Default is <ref>HTTP_IMPORT_NONE</ref>. - </text><group><seealso/><text><ref>HTTP_IMPORT_NONE</ref>, <ref>HTTP_IMPORT_GREEDY</ref> and - <ref>HTTP_IMPORT_ANY</ref>. - </text></group></doc> - <variable name='http_import'><modifiers><public/></modifiers><type><int><min>0</min><max>2</max></int></type></variable> - </docgroup> - <docgroup homogen-name='http_import_allow_ct' homogen-type='variable'><doc><text>List of allowed content types if <ref resolved='predef::_Sass.Compiler.http_import'>http_import</ref> is set to - <ref>HTTP_IMPORT_GREEDY</ref>. The default is to allow <tt>text/scss</tt> and - <tt>text/sass</tt>. - </text></doc> - <variable name='http_import_allow_ct'><modifiers><public/></modifiers><type><multiset><indextype><object resolved='predef::_Sass.s8'>s8</object></indextype></multiset></type></variable> - </docgroup> - <docgroup homogen-name='Api' homogen-type='inherit'> - <inherit name='Api'><classname>Api</classname></inherit> - </docgroup> - <docgroup homogen-name='set_options' homogen-type='method'><doc><text>Set options to the SASS compiler. - </text><group><param name='opts'/><text><mapping><group><member><type><int/></type><index>"output_style"</index></member><text>Any of the <ref>STYLE_NESTED</ref>, <ref>STYLE_EXPANDED</ref>, <ref>STYLE_COMPACT</ref> - or <ref>STYLE_COMPRESSED</ref> constants. See also <ref>output_style</ref>. - </text></group><group><member><type><string><min>0</min><max>255</max></string></type><index>"include_path"</index></member><text>Path to root of incude files. See also <ref>include_path</ref>. - </text></group><group><member><type><string><min>0</min><max>255</max></string></type><index>"source_map_file"</index></member><text>File to write source map file to. - See also <ref>source_map_file</ref>. - </text></group><group><member><type><object resolved='predef::bool'>bool</object></type><index>"source_comments"</index></member><text>Turn on/off comments in the output containing info about the source - file - line numbers and such. Default of <tt>false</tt>. See also - <ref>source_comments</ref>. - </text></group><group><member><type><object resolved='predef::bool'>bool</object></type><index>"source_map_embed"</index></member><text>Turn on/off if a source map should be embedded in the output or not. - Default is <tt>false</tt>. See also <ref>source_map_embed</ref>. - </text></group><group><member><type><string><min>0</min><max>255</max></string></type><index>"source_map_root"</index></member><text>Set the root path of the source files, relative to where the - source.map file is written. - See also <ref>source_map_root</ref> - </text></group><group><member><type><object resolved='predef::bool'>bool</object></type><index>"omit_source_map_url"</index></member><text>Omit the #sourceMappingURL or not. - See also <ref>omit_source_map_url</ref> - </text></group><group><member><type><object resolved='predef::bool'>bool</object></type><index>"sass_syntax"</index></member><text>Turn on/off Sass syntax, i.e. indented syntax. Only necessary when - using <ref resolved='predef::compile_string'>compile_string()</ref> - </text></group><group><member><type><int/></type><index>"precision"</index></member><text>Floating point precision. See also <ref>precision</ref>. - </text></group></mapping> - </text></group></doc> - <method name='set_options'> - <arguments><argument name='opts'><type><mapping><indextype><object resolved='predef::_Sass.s8'>s8</object></indextype><valuetype><or><object resolved='predef::_Sass.s8'>s8</object><int/></or></valuetype></mapping></type></argument></arguments> - <returntype><void/></returntype> - </method> - </docgroup> - </class> - </module> + <module name='__builtin'> <module name='Nettle'> <class name='AE'> <doc><text>Base class for AE (Authenticated Encryption) algorithms. AE algorithms behave like a combination of a <ref resolved='predef::__builtin.Nettle.Cipher'>Cipher</ref> and a HMAC. Note that no actual AE algorithm is implemented in the base class. They are implemented in classes that inherit this class. </text><group><seealso/><text><ref resolved='predef::__builtin.Nettle.AEAD'>AEAD</ref>

autodoc.git / traditional.xml