Add better documentation blocks.

This commit is contained in:
Ovidiu Bute
2019-01-03 15:49:40 +02:00
parent 5a2b7b2f01
commit dc1aa97bd1
+11 -3
View File
@@ -5,7 +5,10 @@ import Linkify from "linkifyjs/react";
declare function describe(desc: string, f: () => void): void;
describe("linkifyjs/html", () => {
// From the docs here: https://soapbox.github.io/linkifyjs/docs/options.html
/**
* The following tests were taken directly from the documentation:
* https://soapbox.github.io/linkifyjs/docs/options.html
*/
/* attributes */
@@ -147,7 +150,10 @@ describe("linkifyjs/html", () => {
});
describe("linkifyjs/react", () => {
// From the docs here: https://soapbox.github.io/linkifyjs/docs/linkify-react.html
/**
* The following tests were taken directly from the documentation:
* https://soapbox.github.io/linkifyjs/docs/linkify-react.html
*/
/* Usage */
@@ -178,7 +184,9 @@ describe("linkifyjs/react", () => {
<Linkify options={{ attributes: linkProps }}>{content}</Linkify>;
}
/* A few more test cases */
/**
* The following tests were made specifically for DefinitelyTyped.
*/
/* Default values for all props */
{