Skip to content

Commit 0495edf

Browse files
authored
WOQLClient: Fix JSDoc
The documentation contained very weird `module__` prefixes. This was because we were documenting the WOQLClient class as a module, even though it is a class instead of a module. This fixes the generated documentation to be much nicer.
1 parent f3ccb85 commit 0495edf

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

lib/woqlClient.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ const WOQLQuery = require('./query/woqlCore');
1515

1616
/**
1717
* @license Apache Version 2
18-
* @module WOQLClient
19-
* @description The core functionality of the TerminusDB javascript client is
18+
* @class
19+
* @classdesc The core functionality of the TerminusDB javascript client is
2020
* defined in the WOQLClient class - in the woqlClient.js file. This class provides
2121
* methods which allow you to directly get and set all of the configuration and API
2222
* endpoints of the client. The other parts of the WOQL core - connectionConfig.js

0 commit comments

Comments
 (0)