Use JSDoc comments for documentation #387

akwanpdf · 2021-09-23T23:21:21Z

This update changes the way APIs will be documented in this repo. Instead of being written in API.md, docs will now be written in the source files using JSDoc comments (see API documentation wiki for guide to creating/editing/publishing docs).

Viewing docs This update allows HTML files to be generated for these docs. To see the doc files in your browser, click any API hyperlink in the README or click here.

Generating docs locally To generate local doc files, run npm start in the outer repo's example folder, then open these files in your browser to see any changes you made.

Docs for users GitHub Actions will automatically generate docs in master.

Doc website template Currently we are using a forked version of DocStrap edited to work for this library.

* Added export for PDFViewCtrl in index.d.ts * Fixed config.options.d.ts exports in index.d.ts * Added exports for the remainig interfaces within document_view.d.ts * Fixed error in document_view.d.ts

…-native into ts-support

* Rect to include width and height optional properties * Annotation to include pageRect and screenRect optional properties

…into ts-typedocs

akwanpdf · 2021-11-22T22:48:28Z

README.md

@@ -1,6 +1,6 @@
 # PDFTron React Native Wrapper

- [API](API.md)
+- [API](https://raw.githack.com/PDFTron/pdftron-react-native/ts-typedocs-master/docs/index.html)


(Will change to pdftron.com once the docs are up).

DocHome.md

sgong-pdftron · 2021-12-04T00:02:16Z

docs/scripts/prettify/prettify.js

@@ -0,0 +1,496 @@
+var q = null;
+window.PR_SHOULD_USE_CONTINUATION = !0;


can you explain how is prettify used?

The JSDoc website states that:

By default, JSDoc's default template generates pretty-printed versions of your source files. It also links to these pretty-printed files in the documentation.

I believe that prettify.js is the file responsible for this. It looks that it has been replaced in the official JSDoc repo by the Prettier library, but active development of Docstrap probably ended before this change was made.

i feel very uneasy to include source code of other third party software here, same with the icons, we should discuss them

sgong-pdftron · 2021-12-04T00:02:56Z

docs/fonts/glyphicons-halflings-regular.svg

@@ -0,0 +1,288 @@
+<?xml version="1.0" standalone="no"?>


is the usage for all fonts/image resources copy-right permitted? where are these from?

DocStrap is based off of Bootstrap. Within Bootstrap's components are the set of Glyphicons that you are seeing in the fonts folder. Boostrap states here that these glyphs are free to use.

- Also restore ts-typedocs scripts and dev dependencies

into ts-typedocs

into ts-typedocs � Conflicts: � API.md � lib/src/Config/Config.js � lib/src/DocumentView/DocumentView.js � src/Config/Config.ts � src/DocumentView/DocumentView.tsx

dcupidon and others added 30 commits July 23, 2021 17:23

Fixed typings for PDFViewCtrl

9d743a9

Changes to index.d.ts and document_view.d.ts

7c4ea88

* Added export for PDFViewCtrl in index.d.ts * Fixed config.options.d.ts exports in index.d.ts * Added exports for the remainig interfaces within document_view.d.ts * Fixed error in document_view.d.ts

Refactor exports and fix a type

76dd861

specify object interface for onBehaviorActivated

995b522

Fixed onDocumentLoaded and onDocumentError typing

3d58ce1

move types to own folder

039d16b

Edit filepaths

aee36c2

Edit mode prop types

85aee63

Edit onToolChanged types

8f0496a

Updated package.json files

f515f01

Added missing import in AnnotOptions.d.ts

9e9fb8e

edit reflowOrientation type

0ff161f

Merge branch 'ts-support' of https://github.com/PDFTron/pdftron-react…

b524d5a

…-native into ts-support

edit defaultEraserType type

63df86d

Use promises for method return types

c0fa9a5

make initialLoad optional

4223cda

Updated interfaces

7955a64

* Rect to include width and height optional properties * Annotation to include pageRect and screenRect optional properties

make CropBox from Rect

37d2d0c

Updated definition of CropBox

d382162

Merge branch 'master' into ts-support

903c217

Add types from latest master updates

f7fbc9a

Use Record utility

cd36407

Remove redundant null

f9d54e7

Merge branch 'master' into ts-support

03414a5

Add save copy option buttons

90143cd

Redefined CustomToolbarKey in ConfigOptions.d.ts

69cb599

Added pageRect and screenRect to stickyNoteData

fd247eb

fix typo

71b8f69

Use parameter destructuring

2cbf595

migrate js files to ts, tsx

c46ff35

akwanpdf added 3 commits September 23, 2021 13:55

Merge branch ts-support-js-to-tsinto ts-typedocs

ee20312

Merge remote-tracking branch 'origin/dev' into ts-typedocs

0d3e52d

Restore JSDoc'd DocumentView.tsx

3927701

akwanpdf requested review from sgong-pdftron and JamesTron September 23, 2021 23:21

dcupidon changed the base branch from master to dev September 24, 2021 00:09

dcupidon and others added 5 commits October 4, 2021 11:25

Merge branch 'dev' of https://github.com/PDFTron/pdftron-react-native …

c85d661

…into ts-typedocs

Merge branch 'dev' into ts-typedocs

f420646

Fix link typo

d8f0b38

Merge branch 'dev' of https://github.com/PDFTron/pdftron-react-native …

0361a6f

…into ts-typedocs

Merge branch 'master' into ts-typedocs

a262c39

akwanpdf changed the base branch from dev to master November 22, 2021 22:22

akwanpdf and others added 2 commits November 22, 2021 14:24

bump ver

b279153

Updating JS files

aef8ea9

akwanpdf commented Nov 22, 2021

View reviewed changes

sgong-pdftron requested changes Dec 4, 2021

View reviewed changes

akwanpdf and others added 13 commits December 6, 2021 12:36

Ignore pdfviewctrl in docs

2f6cce6

- Also restore ts-typedocs scripts and dev dependencies

Remove vanilla theme, add upload-docs script

f67cb13

Merge branch 'master' of https://github.com/PDFTron/pdftron-react-native

e1de2a8

into ts-typedocs

Remove excess script

63eba74

Trying to alleviate node bug in build process

566b21c

Continued tests to eliminate node bug

dc7c11b

Updating build process to fix Node bug

b62144e

Updating JS files

9ffc0a3

Removed API docs website

6bfa619

Merge branch 'master' of https://github.com/PDFTron/pdftron-react-native

58c5d79

into ts-typedocs

Merge branch 'master' of https://github.com/PDFTron/pdftron-react-native

561ea78

into ts-typedocs � Conflicts: � API.md � lib/src/Config/Config.js � lib/src/DocumentView/DocumentView.js � src/Config/Config.ts � src/DocumentView/DocumentView.tsx

updating the documentview file

8fc6b62

Updating JS files

c464158

sgong-pdftron marked this pull request as draft March 1, 2023 16:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use JSDoc comments for documentation #387

Use JSDoc comments for documentation #387

akwanpdf commented Sep 23, 2021 •

edited

akwanpdf Nov 22, 2021

sgong-pdftron Dec 4, 2021

dcupidon Dec 6, 2021

sgong-pdftron Dec 6, 2021

sgong-pdftron Dec 4, 2021

dcupidon Dec 6, 2021

		@@ -0,0 +1,496 @@
		var q = null;
		window.PR_SHOULD_USE_CONTINUATION = !0;

Use JSDoc comments for documentation #387

Are you sure you want to change the base?

Use JSDoc comments for documentation #387

Conversation

akwanpdf commented Sep 23, 2021 • edited

akwanpdf Nov 22, 2021

Choose a reason for hiding this comment

sgong-pdftron Dec 4, 2021

Choose a reason for hiding this comment

dcupidon Dec 6, 2021

Choose a reason for hiding this comment

sgong-pdftron Dec 6, 2021

Choose a reason for hiding this comment

sgong-pdftron Dec 4, 2021

Choose a reason for hiding this comment

dcupidon Dec 6, 2021

Choose a reason for hiding this comment

akwanpdf commented Sep 23, 2021 •

edited