Project Annotations
Summary
This document itemises the use of annotations in this project.
Related documents
| View | Description | Format |
|---|---|---|
| index.html | Index of sources | xhtml |
| imports | Summary of import usage | xhtml |
| restxq | Summary of REST interface | xhtml |
| mermaid | Project wide module imports as a mermaid class diagram | html5 |
| xqdoca.xml | xqDocA run configuration report (XML) | xml |
Annotations
There are 5 annotation namespaces in use.
2.1 http://basex.org
lazy{http://basex.org}lazy2
| Attached to | Values |
|---|---|
| options:$DEFAULTS | () |
| options:$OPTIONS | () |
2.2 http://basex.org/modules/perm
allowcheck{http://basex.org/modules/perm}allow3
| Attached to | Values |
|---|---|
| dba:file#1 | ('public') |
| dba:login#3 | ('public') |
| dba:login-check#3 | ('public') |
{http://basex.org/modules/perm}check1
| Attached to | Values |
|---|---|
| dba:check#1 | ('/dba','{$perm}') |
2.3 http://exquery.org/ns/restxq
GETPOSTform-parampathquery-paramsingle{http://exquery.org/ns/restxq}form-param29
| Attached to | Values |
|---|---|
| dba:db-add-post#5 | ('name','{$name}') |
| dba:db-add-post#5 | ('opts','{$opts}') |
| dba:db-add-post#5 | ('path','{$path}') |
| dba:db-add-post#5 | ('file','{$file}') |
| dba:db-add-post#5 | ('binary','{$binary}') |
| dba:db-replace-post#3 | ('name','{$name}') |
| dba:db-replace-post#3 | ('resource','{$resource}') |
| dba:db-replace-post#3 | ('file','{$file}') |
| dba:resource-redirect#3 | ('action','{$action}') |
| dba:resource-redirect#3 | ('name','{$name}') |
| dba:resource-redirect#3 | ('resource','{$resource}') |
| dba:database-redirect#4 | ('action','{$action}') |
| dba:database-redirect#4 | ('name','{$name}') |
| dba:database-redirect#4 | ('resource','{$resources}') |
| dba:database-redirect#4 | ('backup','{$backups}') |
| dba:db-optimize#4 | ('name','{$name}') |
| dba:db-optimize#4 | ('all','{$all}') |
| dba:db-optimize#4 | ('opts','{$opts}') |
| dba:db-optimize#4 | ('lang','{$lang}') |
| dba:file-upload#1 | ('files','{$files}') |
| dba:user-edit#5 | ('name','{$name}') |
| dba:user-edit#5 | ('newname','{$newname}') |
| dba:user-edit#5 | ('pw','{$pw}') |
| dba:user-edit#5 | ('perm','{$perm}') |
| dba:user-edit#5 | ('info','{$info}') |
| dba:user-redirect#3 | ('action','{$action}') |
| dba:user-redirect#3 | ('name','{$name}') |
| dba:user-redirect#3 | ('pattern','{$patterns}') |
| dba:users-info#1 | ('info','{$info}') |
{http://exquery.org/ns/restxq}GET38
{http://exquery.org/ns/restxq}path78
| Attached to | Values |
|---|---|
| dba:backup-download#1 | ('/dba/backup/{$backup}') |
| dba:db-add#5 | ('/dba/db-add') |
| dba:db-add-post#5 | ('/dba/db-add') |
| dba:db-delete#2 | ('/dba/db-delete') |
| dba:db-download#2 | ('/dba/db-download') |
| dba:db-query#3 | ('/dba/db-query') |
| dba:db-rename#4 | ('/dba/db-rename') |
| dba:db-rename#3 | ('/dba/db-rename') |
| dba:db-replace#3 | ('/dba/db-replace') |
| dba:db-replace-post#3 | ('/dba/db-replace') |
| dba:resource-redirect#3 | ('/dba/resource') |
| dba:backup-create#1 | ('/dba/backup-create') |
| dba:backup-drop#2 | ('/dba/backup-drop') |
| dba:backup-restore#2 | ('/dba/backup-restore') |
| dba:database#6 | ('/dba/database') |
| dba:database-redirect#4 | ('/dba/database') |
| dba:databases#4 | ('/dba/databases') |
| dba:databases-redirect#2 | ('/dba/databases') |
| dba:db-alter#3 | ('/dba/db-alter') |
| dba:db-alter#2 | ('/dba/db-alter') |
| dba:db-copy#3 | ('/dba/db-copy') |
| dba:db-copy#2 | ('/dba/db-copy') |
| dba:db-create#4 | ('/dba/db-create') |
| dba:db-create#3 | ('/dba/db-create') |
| dba:db-drop#1 | ('/dba/db-drop') |
| dba:db-optimize#5 | ('/dba/db-optimize') |
| dba:db-optimize#4 | ('/dba/db-optimize') |
| dba:db-optimize-all#1 | ('/dba/db-optimize-all') |
| dba:dir-change#1 | ('/dba/dir-change') |
| dba:dir-create#1 | ('/dba/dir-create') |
| dba:file-delete#1 | ('/dba/file-delete') |
| dba:file-download#1 | ('/dba/file/{$name}') |
| dba:file-start#1 | ('/dba/file-start') |
| dba:file-stop#1 | ('/dba/file-stop') |
| dba:file-upload#1 | ('/dba/file-upload') |
| dba:files#4 | ('/dba/files') |
| dba:files-redirect#2 | ('/dba/files') |
| dba:job-result#1 | ('/dba/job-result') |
| dba:job-stop#1 | ('/dba/job-stop') |
| dba:job-discard#1 | ('/dba/job-discard') |
| dba:jobs#4 | ('/dba/jobs') |
| dba:jobs-redirect#2 | ('/dba/jobs') |
| dba:log-delete#1 | ('/dba/log-delete') |
| dba:log-download#1 | ('/dba/log-download') |
| dba:logs-jump#2 | ('/dba/logs-jump') |
| dba:logs#7 | ('/dba/logs') |
| dba:log#5 | ('/dba/log') |
| dba:logs-redirect#2 | ('/dba/logs') |
| dba:queries#3 | ('/dba/queries') |
| dba:query-save#1 | ('/dba/query-close') |
| dba:query-eval#1 | ('/dba/query-eval') |
| dba:query-update#1 | ('/dba/query-update') |
| dba:query-open#1 | ('/dba/query-open') |
| dba:query-save#2 | ('/dba/query-save') |
| dba:drop#1 | ('/dba/session-kill') |
| dba:sessions#3 | ('/dba/sessions') |
| dba:users-redirect#3 | ('/dba/sessions') |
| dba:settings-gc#0 | ('/dba/settings-gc') |
| dba:settings#2 | ('/dba/settings') |
| dba:settings-save#0 | ('/dba/settings') |
| dba:pattern-add#4 | ('/dba/pattern-add') |
| dba:create#3 | ('/dba/pattern-add') |
| dba:pattern-drop#2 | ('/dba/pattern-drop') |
| dba:user-create#4 | ('/dba/user-create') |
| dba:user-create#3 | ('/dba/user-create') |
| dba:user-drop#1 | ('/dba/user-drop') |
| dba:user-edit#5 | ('/dba/user-edit') |
| dba:user#6 | ('/dba/user') |
| dba:user-redirect#3 | ('/dba/user') |
| dba:users-info#1 | ('/dba/users-info') |
| dba:users#3 | ('/dba/users') |
| dba:users-redirect#3 | ('/dba/users') |
| dba:redirect#0 | ('/dba') |
| dba:file#1 | ('/dba/static/{$file=.+}') |
| dba:unknown#1 | ('/dba/{$path}') |
| dba:login#3 | ('/dba/login') |
| dba:login-check#3 | ('/dba/login-check') |
| dba:logout#0 | ('/dba/logout') |
{http://exquery.org/ns/restxq}POST32
{http://exquery.org/ns/restxq}query-param149
| Attached to | Values |
|---|---|
| dba:db-add#5 | ('name','{$name}') |
| dba:db-add#5 | ('opts','{$opts}') |
| dba:db-add#5 | ('path','{$path}') |
| dba:db-add#5 | ('binary','{$binary}') |
| dba:db-add#5 | ('error','{$error}') |
| dba:db-delete#2 | ('name','{$name}') |
| dba:db-delete#2 | ('resource','{$resources}') |
| dba:db-download#2 | ('name','{$name}') |
| dba:db-download#2 | ('resource','{$resource}') |
| dba:db-query#3 | ('name','{$name}') |
| dba:db-query#3 | ('resource','{$resource}') |
| dba:db-rename#4 | ('name','{$name}') |
| dba:db-rename#4 | ('resource','{$resource}') |
| dba:db-rename#4 | ('target','{$target}') |
| dba:db-rename#4 | ('error','{$error}') |
| dba:db-rename#3 | ('name','{$name}') |
| dba:db-rename#3 | ('resource','{$resource}') |
| dba:db-rename#3 | ('target','{$target}') |
| dba:db-replace#3 | ('name','{$name}') |
| dba:db-replace#3 | ('resource','{$resource}') |
| dba:db-replace#3 | ('error','{$error}') |
| dba:backup-create#1 | ('name','{$name}') |
| dba:backup-drop#2 | ('name','{$name}') |
| dba:backup-drop#2 | ('backup','{$backups}') |
| dba:backup-restore#2 | ('name','{$name}') |
| dba:backup-restore#2 | ('backup','{$backup}') |
| dba:database#6 | ('name','{$name}','') |
| dba:database#6 | ('resource','{$resource}') |
| dba:database#6 | ('sort','{$sort}','') |
| dba:database#6 | ('page','{$page}',1) |
| dba:database#6 | ('info','{$info}') |
| dba:database#6 | ('error','{$error}') |
| dba:databases#4 | ('sort','{$sort}','') |
| dba:databases#4 | ('page','{$page}',1) |
| dba:databases#4 | ('info','{$info}') |
| dba:databases#4 | ('error','{$error}') |
| dba:databases-redirect#2 | ('action','{$action}') |
| dba:databases-redirect#2 | ('name','{$names}') |
| dba:db-alter#3 | ('name','{$name}') |
| dba:db-alter#3 | ('newname','{$newname}') |
| dba:db-alter#3 | ('error','{$error}') |
| dba:db-alter#2 | ('name','{$name}') |
| dba:db-alter#2 | ('newname','{$newname}') |
| dba:db-copy#3 | ('name','{$name}') |
| dba:db-copy#3 | ('newname','{$newname}') |
| dba:db-copy#3 | ('error','{$error}') |
| dba:db-copy#2 | ('name','{$name}') |
| dba:db-copy#2 | ('newname','{$newname}') |
| dba:db-create#4 | ('name','{$name}') |
| dba:db-create#4 | ('opts','{$opts}') |
| dba:db-create#4 | ('lang','{$lang}','en') |
| dba:db-create#4 | ('error','{$error}') |
| dba:db-create#3 | ('name','{$name}') |
| dba:db-create#3 | ('opts','{$opts}') |
| dba:db-create#3 | ('lang','{$lang}') |
| dba:db-drop#1 | ('name','{$names}') |
| dba:db-optimize#5 | ('name','{$name}') |
| dba:db-optimize#5 | ('all','{$all}') |
| dba:db-optimize#5 | ('opts','{$opts}') |
| dba:db-optimize#5 | ('lang','{$lang}','en') |
| dba:db-optimize#5 | ('error','{$error}') |
| dba:db-optimize-all#1 | ('name','{$names}') |
| dba:dir-change#1 | ('dir','{$dir}') |
| dba:dir-create#1 | ('name','{$name}') |
| dba:file-delete#1 | ('name','{$names}') |
| dba:file-start#1 | ('file','{$file}','') |
| dba:file-stop#1 | ('id','{$id}') |
| dba:files#4 | ('sort','{$sort}','') |
| dba:files#4 | ('error','{$error}') |
| dba:files#4 | ('info','{$info}') |
| dba:files#4 | ('page','{$page}','1') |
| dba:files-redirect#2 | ('action','{$action}') |
| dba:files-redirect#2 | ('name','{$names}') |
| dba:job-result#1 | ('id','{$id}','') |
| dba:job-stop#1 | ('id','{$ids}') |
| dba:job-discard#1 | ('id','{$ids}') |
| dba:jobs#4 | ('sort','{$sort}','duration') |
| dba:jobs#4 | ('job','{$job}') |
| dba:jobs#4 | ('error','{$error}') |
| dba:jobs#4 | ('info','{$info}') |
| dba:jobs-redirect#2 | ('action','{$action}') |
| dba:jobs-redirect#2 | ('id','{$ids}') |
| dba:log-delete#1 | ('name','{$names}') |
| dba:log-download#1 | ('name','{$name}') |
| dba:logs-jump#2 | ('name','{$name}') |
| dba:logs-jump#2 | ('time','{$time}') |
| dba:logs#7 | ('input','{$input}') |
| dba:logs#7 | ('name','{$name}') |
| dba:logs#7 | ('sort','{$sort}','') |
| dba:logs#7 | ('error','{$error}') |
| dba:logs#7 | ('info','{$info}') |
| dba:logs#7 | ('page','{$page}','1') |
| dba:logs#7 | ('time','{$time}') |
| dba:log#5 | ('name','{$name}') |
| dba:log#5 | ('sort','{$sort}','time') |
| dba:log#5 | ('page','{$page}','1') |
| dba:log#5 | ('time','{$time}') |
| dba:logs-redirect#2 | ('action','{$action}') |
| dba:logs-redirect#2 | ('name','{$names}') |
| dba:queries#3 | ('error','{$error}') |
| dba:queries#3 | ('info','{$info}') |
| dba:queries#3 | ('file','{$file}') |
| dba:query-save#1 | ('name','{$name}') |
| dba:query-open#1 | ('name','{$name}') |
| dba:query-save#2 | ('name','{$name}') |
| dba:drop#1 | ('id','{$ids}') |
| dba:sessions#3 | ('sort','{$sort}','access') |
| dba:sessions#3 | ('error','{$error}') |
| dba:sessions#3 | ('info','{$info}') |
| dba:users-redirect#3 | ('action','{$action}') |
| dba:users-redirect#3 | ('name','{$names}') |
| dba:users-redirect#3 | ('id','{$ids}') |
| dba:settings#2 | ('error','{$error}') |
| dba:settings#2 | ('info','{$info}') |
| dba:pattern-add#4 | ('name','{$name}') |
| dba:pattern-add#4 | ('pattern','{$pattern}') |
| dba:pattern-add#4 | ('perm','{$perm}','write') |
| dba:pattern-add#4 | ('error','{$error}') |
| dba:create#3 | ('name','{$name}') |
| dba:create#3 | ('perm','{$perm}') |
| dba:create#3 | ('pattern','{$pattern}') |
| dba:pattern-drop#2 | ('name','{$name}') |
| dba:pattern-drop#2 | ('pattern','{$patterns}') |
| dba:user-create#4 | ('name','{$name}') |
| dba:user-create#4 | ('pw','{$pw}') |
| dba:user-create#4 | ('perm','{$perm}','none') |
| dba:user-create#4 | ('error','{$error}') |
| dba:user-create#3 | ('name','{$name}') |
| dba:user-create#3 | ('pw','{$pw}') |
| dba:user-create#3 | ('perm','{$perm}') |
| dba:user-drop#1 | ('name','{$names}') |
| dba:user#6 | ('name','{$name}') |
| dba:user#6 | ('newname','{$newname}') |
| dba:user#6 | ('pw','{$pw}') |
| dba:user#6 | ('perm','{$perm}') |
| dba:user#6 | ('error','{$error}') |
| dba:user#6 | ('info','{$info}') |
| dba:users#3 | ('sort','{$sort}','name') |
| dba:users#3 | ('error','{$error}') |
| dba:users#3 | ('info','{$info}') |
| dba:users-redirect#3 | ('action','{$action}') |
| dba:users-redirect#3 | ('name','{$names}') |
| dba:users-redirect#3 | ('id','{$ids}') |
| dba:login#3 | ('_name','{$name}') |
| dba:login#3 | ('_error','{$error}') |
| dba:login#3 | ('_page','{$page}') |
| dba:login-check#3 | ('_name','{$name}') |
| dba:login-check#3 | ('_pass','{$pass}') |
| dba:login-check#3 | ('_page','{$page}') |
{http://exquery.org/ns/restxq}single4
| Attached to | Values |
|---|---|
| dba:db-query#3 | () |
| dba:log#5 | () |
| dba:query-eval#1 | () |
| dba:query-update#1 | () |
2.4 http://www.w3.org/2010/xslt-xquery-serialization
html-versionindentmethod{http://www.w3.org/2010/xslt-xquery-serialization}html-version1
| Attached to | Values |
|---|---|
| dba:log#5 | ('5.0') |
{http://www.w3.org/2010/xslt-xquery-serialization}indent1
| Attached to | Values |
|---|---|
| dba:log#5 | ('no') |
{http://www.w3.org/2010/xslt-xquery-serialization}method28
| Attached to | Values |
|---|---|
| dba:db-add#5 | ('html') |
| dba:db-query#3 | ('text') |
| dba:db-rename#4 | ('html') |
| dba:db-replace#3 | ('html') |
| dba:database#6 | ('html') |
| dba:databases#4 | ('html') |
| dba:db-alter#3 | ('html') |
| dba:db-copy#3 | ('html') |
| dba:db-create#4 | ('html') |
| dba:db-optimize#5 | ('html') |
| dba:files#4 | ('html') |
| dba:jobs#4 | ('html') |
| dba:logs#7 | ('html') |
| dba:log#5 | ('html') |
| dba:queries#3 | ('html') |
| dba:query-eval#1 | ('text') |
| dba:query-update#1 | ('text') |
| dba:query-open#1 | ('text') |
| dba:query-save#2 | ('text') |
| dba:sessions#3 | ('html') |
| dba:settings#2 | ('html') |
| dba:pattern-add#4 | ('html') |
| dba:user-create#4 | ('html') |
| dba:user#6 | ('html') |
| dba:users#3 | ('html') |
| dba:file#1 | ('basex') |
| dba:unknown#1 | ('html') |
| dba:login#3 | ('html') |