Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add OpenCascade's comments into typescript defintions #67

Open
donalffons opened this issue Jul 3, 2021 · 1 comment
Open

Add OpenCascade's comments into typescript defintions #67

donalffons opened this issue Jul 3, 2021 · 1 comment

Comments

@donalffons
Copy link
Owner

Those comments will then be visible via "Intellisense" in most editors / IDEs.

@donalffons donalffons changed the title Add OpenCascade's comment into typescript defintions Add OpenCascade's comments into typescript defintions Jul 4, 2021
@donalffons
Copy link
Owner Author

The class TypescriptBindings has all the methods to generate typescript definitions. It "returns" the bindings using the string self.output. A good place to start might be the method processClass, which is supposed to output the export declare class [...] line, above which we want to add a typescript comment. The comment should be accessible using theClass.brief_comment.

image

The bindings are generated by the script /opencascade.js/src/generateBindings.py which produces intermediate .d.ts.json files. And the command /opencascade.js/src/buildFromYaml.py /opencascade.js/src/builds/opencascade.full.yml will create a full build (including typescript definitions) in the current directory.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant