vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

Completed #3808

pull/3815/head
Bahadır Sofuoğlu 2023-03-27 13:48:54 +03:00
parent ad6b71074a
commit 8e2777565e
3 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
api-generator/build-apidoc.js
View File

@ -227,7 +227,8 @@ if (project) {
}; };
}), }),
returnType: signature.type.toString(), returnType: signature.type.toString(),
description: signature.comment && signature.comment.summary.map((s) => parseText(s.text || '')).join(' ') description: signature.comment && signature.comment.summary.map((s) => parseText(s.text || '')).join(' '),
deprecated: signature.comment && signature.comment.getTag('@deprecated') ? parseText(signature.comment.getTag('@deprecated').content[0].text) : undefined
}); });
}); });
@ -350,7 +351,8 @@ if (project) {
readonly: prop.flags.isReadonly, readonly: prop.flags.isReadonly,
type: prop.type.toString(), type: prop.type.toString(),
default: prop.comment && prop.comment.getTag('@defaultValue') ? prop.comment.getTag('@defaultValue').content[0].text : '', // TODO: Check default: prop.comment && prop.comment.getTag('@defaultValue') ? prop.comment.getTag('@defaultValue').content[0].text : '', // TODO: Check
description: prop.comment && prop.comment.summary.map((s) => s.text || '').join(' ') description: prop.comment && prop.comment.summary.map((s) => s.text || '').join(' '),
deprecated: prop.comment && prop.comment.getTag('@deprecated') ? parseText(prop.comment.getTag('@deprecated').content[0].text) : undefined
}); });
}); });
@ -395,7 +397,8 @@ if (project) {
}; };
}), }),
returnType: signature.type.toString(), returnType: signature.type.toString(),
description: signature.comment && signature.comment.summary.map((s) => parseText(s.text || '')).join(' ') description: signature.comment && signature.comment.summary.map((s) => parseText(s.text || '')).join(' '),
deprecated: signature.comment && signature.comment.getTag('@deprecated') ? parseText(signature.comment.getTag('@deprecated').content[0].text) : undefined
}); });
}); });
} }

6
layouts/doc/DocApiSection.vue
View File

@ -180,7 +180,8 @@ export default {
type: emit.parameters[0]?.type type: emit.parameters[0]?.type
}, },
returnType: emit.returnType, returnType: emit.returnType,
description: emit.description description: emit.description,
deprecated: emit.deprecated
}); });
} }
@ -194,7 +195,8 @@ export default {
name: prop.name, name: prop.name,
type: prop.type, type: prop.type,
default: prop.default, default: prop.default,
description: prop.description description: prop.description,
deprecated: prop.deprecated
}); });
} }

2
layouts/doc/DocApiTable.vue
View File

@ -21,7 +21,7 @@
<tr v-for="prop in data" :key="prop"> <tr v-for="prop in data" :key="prop">
<td v-for="[k, v] in Object.entries(prop)" :key="k" :class="{ 'doc-option-type': k === 'type', 'doc-option-default': k === 'defaultValue' }"> <td v-for="[k, v] in Object.entries(prop)" :key="k" :class="{ 'doc-option-type': k === 'type', 'doc-option-default': k === 'defaultValue' }">
<template v-if="k !== 'readonly' && k !== 'optional' && k !== 'deprecated'"> <template v-if="k !== 'readonly' && k !== 'optional' && k !== 'deprecated'">
<span v-if="k === 'name'" :id="id + '.' + v" class="doc-option-name"> <span v-if="k === 'name'" :id="id + '.' + v" class="doc-option-name" :class="{ 'line-through cursor-pointer': !!prop.deprecated }" :title="prop.deprecated">
{{ v {{ v
}}<NuxtLink :to="`/${$router.currentRoute.value.name}/#${id}.${v}`" class="doc-option-link"> }}<NuxtLink :to="`/${$router.currentRoute.value.name}/#${id}.${v}`" class="doc-option-link">
<i class="pi pi-link"></i> <i class="pi pi-link"></i>