Scilab Home page | Wiki | Bug tracker | Forge | Mailing list archives | ATOMS | File exchange
Please login or create an account
Change language to: English - Français - 日本語 - Русский

Please note that the recommended version of Scilab is 6.0.1. This page might be outdated.
See the recommended documentation of this function

Ajuda do Scilab >> Gerenciamento de ajuda online > help_skeleton

help_skeleton

constrói o esqueleto do arquivo de ajuda xml associado à função Scilab

Seqüência de Chamamento

txt = help_skeleton(funname [,path [,language]])

Parâmetros

funname

string : o nome da função

path

string : o endereço onde se criará o arquivo, se for requerido. Se este argumento não for fornecido, o esqueleto é retornado como um string.

language

string :com valor possível "fr_FR" ou "en_US" o padrão é "en_US"

txt

o código xml ou o endereço do arquivo xml completo

Descrição

txt = help_skeleton(funname) gera um vetor de strings contendo o esqueleto do código XML descrevendo a ajuda da função funname.

fullpath = help_skeleton(funname,dirpath) gera o código XML descrevendo a ajuda da função funname em um arquivo nomeado funname.xml no diretório especificado pelo endereço dirpath. Neste caso, a função retorna o endereço do arquivo.

Exemplos

function [y, z]=foo(a, b),y=a+b,z=1,endfunction
p=help_skeleton('foo',TMPDIR)
if (isdef('editor') | (funptr('editor')<>0)) then
  editor(p);
end

Ver Também

Scilab Enterprises
Copyright (c) 2011-2017 (Scilab Enterprises)
Copyright (c) 1989-2012 (INRIA)
Copyright (c) 1989-2007 (ENPC)
with contributors
Last updated:
Tue Feb 14 15:09:57 CET 2017