pengjunjie/core
1
0
Fork 1
mirror of https://github.com/ONLYOFFICE/core.git synced 2026-04-07 13:55:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Added some more description to documentation.

Browse Source
This commit is contained in:
Asethone
2023-06-07 13:30:05 +04:00
parent 37e03d6bcc
commit af0836e379
2 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
DesktopEditor/doctrenderer/js_internal/js_base.h
View File

@ -282,7 +282,6 @@ namespace NSJSBase
/** /**
* Embeds specified class in all JS contexts. * Embeds specified class in all JS contexts.
* You can then call `CreateEmbedOjbect('EmbeddedClassName')` for getting an instance of embedded class.
* @tparam T Embedded class name. * @tparam T Embedded class name.
* @param type Specifies how an object of the embedded class will be created. * @param type Specifies how an object of the embedded class will be created.
*/ */
@ -368,12 +367,15 @@ namespace NSJSBase
* If you want to embed your external C++ class in a JS context then do the following: * If you want to embed your external C++ class in a JS context then do the following:
* *
* 1. Make sure that your class is inherit CJSEmbedObject class. * 1. Make sure that your class is inherit CJSEmbedObject class.
* 2. Override `getObject()` method and write its implementation. * 2. Override `getObject()` method and write its implementation if needed.
* 3. Use macro `DECLARE_EMBED_METHODS` in the `public` section of your class declaration. * 3. Use macro `DECLARE_EMBED_METHODS` in the `public` section of your class declaration.
* 4. Include "doctrenderer/js_internal/js_base_embed.pri" in your .pro file. * 4. Include "doctrenderer/js_internal/js_base_embed.pri" in your .pro file.
* 5. Add a line `ADD_FILES_FOR_EMBEDDED_CLASS_HEADER(YourClassHeader.h)` to your .pro file. * 5. Add a line `ADD_FILES_FOR_EMBEDDED_CLASS_HEADER(YourClassHeader.h)` to your .pro file.
* 6. Run the script "doctrenderer/embed/embed.py" with the name of your class header as an argument. * 6. Run the script "doctrenderer/embed/embed.py" with the name of your class header as an argument for generating some necessary files for embedding.
* If you embedding a class for doctrenderer library, then also specify `--internal` (or just `-i`) option. * If you're going to embed a class for doctrenderer library, then also specify `--internal` (or just `-i`) option.
* 7. In C++ code call `CJSContext::Embed<YourClassName>()`.
*
* You can then call `CreateEmbedOjbect('YourClassName')` in JS code for getting an instance of the embedded class and use its methods.
*/ */
#endif // _CORE_EXT_JS_BASE_H_ #endif // _CORE_EXT_JS_BASE_H_

1
DesktopEditor/doctrenderer/js_internal/v8/v8_base.h
View File

@ -889,7 +889,6 @@ namespace NSJSBase
static void CreateWeaker(v8::Local<v8::Object> obj) static void CreateWeaker(v8::Local<v8::Object> obj)
{ {
// ???
new CJSEmbedObjectPrivate(obj); new CJSEmbedObjectPrivate(obj);
} }
}; };