Skip to content

Commit 5eba0ac

Browse files
committed
improve JavaDoc mimic
1 parent 85c2c91 commit 5eba0ac

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/documentation.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ ${info.type} ${item}
6969
\`\`\``,
7070
`${info.examples ? "" : `${item}\n\n`}${info.description}
7171
72-
@see {@link [${info.docUrl}](${info.docUrl})}
72+
*@see* — [${info.docUrl}](${info.docUrl})
7373
`,
7474
])
7575

@@ -81,12 +81,12 @@ const documentFuntion = (
8181
const typeDefs = desc.indexOf(":")
8282

8383
if (typeDefs === -1) {
84-
return `@param \`${name}\` — ${desc}`
84+
return `*@param* \`${name}\` — ${desc}`
8585
}
8686

8787
const formattedDesc = `\`${desc.slice(0, typeDefs)}\`${desc.slice(typeDefs)}`
8888

89-
return `@param \`${name}\` — ${formattedDesc}`
89+
return `*@param* \`${name}\` — ${formattedDesc}`
9090
})
9191
const {returns} = info
9292

@@ -104,11 +104,11 @@ ${info.syntax}
104104
: []),
105105
`${info.syntax ? "" : `${item}\n\n`}${info.description}
106106
107-
@see {@link [${info.docUrl}](${info.docUrl})}
107+
*@see* — [${info.docUrl}](${info.docUrl})
108108
109109
${params.join("\n\n")}
110110
111-
${returns ? `@returns ${returns === "void" ? "`void`" : returns}` : ""}
111+
${returns ? `*@returns* \`${returns}\`` : ""}
112112
`,
113113
])
114114
}
@@ -121,12 +121,12 @@ const documentClass = (
121121
const typeDefs = desc.indexOf(":")
122122

123123
if (typeDefs === -1) {
124-
return `@param \`${name}\` — ${desc}`
124+
return `*@param* \`${name}\` — ${desc}`
125125
}
126126

127127
const formattedDesc = `\`${desc.slice(0, typeDefs)}\`${desc.slice(typeDefs)}`
128128

129-
return `@param \`${name}\` — ${formattedDesc}`
129+
return `*@param* \`${name}\` — ${formattedDesc}`
130130
})
131131

132132
// Prepare yourself
@@ -143,7 +143,7 @@ ${info.syntax}
143143
: []),
144144
`${info.syntax ? "" : `${item}\n\n`}${info.description}
145145
146-
@see {@link [${info.docUrl}](${info.docUrl})}
146+
*@see* — [${info.docUrl}](${info.docUrl})
147147
148148
${params.join("\n\n")}
149149
`,

0 commit comments

Comments
 (0)