Skip to content

Commit 6e19fa9

Browse files
committed
Add instruction in comment
1 parent 4788a05 commit 6e19fa9

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/theme/JavadocLink.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ export default function JavadocLink({ packageName, path, className }) {
1515
console.log('Docs ClassName:', docsClassName);
1616

1717
// The link in the <a> code below is generated based on the following JavadocLink component that must be added in place of a static Javadoc link in the doc:
18-
// <JavadocLink packageName="scalardl-common" path="com/scalar/dl/ledger/config" className="LedgerConfig" />
18+
// <JavadocLink packageName="<PACKAGE_NAME>" path="<PATH>" className="<CLASS_NAME>" />
19+
// In addition, be sure to add the following below the title to import the component:
20+
// import JavadocLink from "/src/theme/JavadocLink.js";
1921
return (
2022
<a
2123
href={`https://javadoc.io/static/com.scalar-labs/${packageName}/${docsClassName}/${path}/${className}.html`}

0 commit comments

Comments
 (0)