I'm writing in JS, and I use JSDoc comments to generate both my API documentation and my TypeScript declaration files. However, I have a couple of functions that I'd like to keep out of my TS code -- but I still want to include them in my API reference docs. Is this possible? Is there any sort of tag that tells JSDoc, "document this function but leave it out of the .d.ts file"?
Set a JSDoc comment to generate API documentation without adding a TypeScript declaration to the .d.ts file
186 Views Asked by alec At
0
There are 0 best solutions below
Related Questions in TYPESCRIPT
- Use translateProvider.useLoader with Typescript
- Optional method in base class
- Putting Lambdas in OR statement
- Deleting namespace in Socket IO
- Angularjs+Typescript directive implementing $compile
- Typescript type inference inside for loop
- Why void functions are allowed in left part of assignment in Typescript?
- Tools for Apache Cordova - TypeScript debugger jumps to wrong line
- Typescript - is there a way to specify a global reference?
- How to angularjs app.service and $q in typescript
- include typescript file in output result build with TFS
- Mocking Angular $window in unit test cases
- Difference between `share()` and `publish().refCount()`
- TypeScript: workaround for relative reference path?
- How to define knex migrations using Typescript
Related Questions in JSDOC
- Default "Home" text and content for JSDoc
- jsdoc not documenting properly nodejs modules
- @memberof for shared class methods?
- Nested Methods in sidebar of JSDoc
- JSDoc - How to document methods of a prototype object
- JSDoc outputs same variable twice
- JSDoc on an object's properties to describe params of a function
- Describe property defined with Object.defineProperty
- Webstorm interface implementation warning using JSDoc
- Closure annotation for variadic function
- How to display Javascript methods in a 'group' in JSDOC?
- Documenting an array of objects as a parameter of callback function in JSDoc
- JSDoc: node, events, listeners
- How to make file starting with underscore ( _ ) appear in output?
- Typescript JSDoc events are global
Related Questions in TYPESCRIPT-DECLARATIONS
- How to embed facebook posts in angular2 app
- Could not find the declaration file of my Typescript library even when it exists
- Best practice for exporting types from declaration file to external project
- importing into index.d.ts is breaking my types
- Add typings of react-table library to the build using rollup
- In a handwritten d.ts file, how can I expose functions from one namespace in the module root?
- In Typescript, how do you export concrete string enums in your module typing definitions?
- What's the purpose of "declare module name_without_quotes" kind of declarations in typescript (compared to ones with quoted names)
- Is there any significant meaning for `.d.ts` filenames except for readability?
- Overriding default jsdoc -> .d.ts conversion to get rid of ...args: any[]
- How to force typescript to load .d.ts file containing [declare module ".someExtension"] from npm package (from node_modules directory)
- Custom .d.ts file for NPM library not found by TSC
- typescript how to declare class with a method with a parameter of type string that is property name of derived class of specific type
- How can I add type declarations to a local non-JavaScript file?
- Set a JSDoc comment to generate API documentation without adding a TypeScript declaration to the .d.ts file
Related Questions in TYPESCRIPT-DEFINITIONS
- How to specify a monkey patched class in the typescript definitions file?
- make a d.ts file to only override exported enum and return all other original defs?
- declare function that adheres to type
- What is the right typescript definition for a specific javascript instantiation pattern
- Configure typescript to compile outside of Node or browser
- Object of objects of arrays in Typescript
- Typescript: use types for explicit import
- How to import react-bootstrap component with children into kotlin-js react app
- How do you import a Typescript type definition file whose top level element is a non-exported namespace?
- ESLint: types for `eslintrc.js`
- Set a JSDoc comment to generate API documentation without adding a TypeScript declaration to the .d.ts file
- Define dynamically generated properties from an inherited class
- Is it possible to mark something as deprecated in typescript?
- Where do Typescript Node Module Implementations live
- React PropTypes throwing instanceof error for class extended with Typescript definitions
Related Questions in API-DOCUMENTATION
- What is the best API documentation approach for Ballerina record types?
- How do I specify language when using OpenAI's Whisper's Python library? And where is its the documentation?
- Custom themes for Slate API documentation?
- How to describe a model in Swagger for an array with simple objects?
- Create custom index.html in asp.net core Redoc as Api-Documentation
- how to customize the swagger UI/OpenApi in spring boot 3 without make my controller look clumsy
- Rswag specs failing for rspec
- Set a JSDoc comment to generate API documentation without adding a TypeScript declaration to the .d.ts file
- Redocly OpenAPI structure error. Property `openapi` is not expected here
- Large Swagger Json file into multi json files
- Which approach to choose in API management: "Code first" vs "Spec first"?
- Change the title in index.rst generated by Sphinx AutoAPI
- spring boot API giving 404 when changing endpoint name
- How to use swagger with a generic jaxrs api that writes response based on query params and response body is written using response builder class
- what is the difference between postman collections and API documentation?
Trending Questions
- UIImageView Frame Doesn't Reflect Constraints
- Is it possible to use adb commands to click on a view by finding its ID?
- How to create a new web character symbol recognizable by html/javascript?
- Why isn't my CSS3 animation smooth in Google Chrome (but very smooth on other browsers)?
- Heap Gives Page Fault
- Connect ffmpeg to Visual Studio 2008
- Both Object- and ValueAnimator jumps when Duration is set above API LvL 24
- How to avoid default initialization of objects in std::vector?
- second argument of the command line arguments in a format other than char** argv or char* argv[]
- How to improve efficiency of algorithm which generates next lexicographic permutation?
- Navigating to the another actvity app getting crash in android
- How to read the particular message format in android and store in sqlite database?
- Resetting inventory status after order is cancelled
- Efficiently compute powers of X in SSE/AVX
- Insert into an external database using ajax and php : POST 500 (Internal Server Error)
Popular Questions
- How do I undo the most recent local commits in Git?
- How can I remove a specific item from an array in JavaScript?
- How do I delete a Git branch locally and remotely?
- Find all files containing a specific text (string) on Linux?
- How do I revert a Git repository to a previous commit?
- How do I create an HTML button that acts like a link?
- How do I check out a remote Git branch?
- How do I force "git pull" to overwrite local files?
- How do I list all files of a directory?
- How to check whether a string contains a substring in JavaScript?
- How do I redirect to another webpage?
- How can I iterate over rows in a Pandas DataFrame?
- How do I convert a String to an int in Java?
- Does Python have a string 'contains' substring method?
- How do I check if a string contains a specific word?