Skip to content

G-API: Addressed various documentation issues#16050

Merged
alalek merged 5 commits intoopencv:masterfrom
dmatveev:dm/ocv42_gapi_doc_fixup
Dec 6, 2019
Merged

G-API: Addressed various documentation issues#16050
alalek merged 5 commits intoopencv:masterfrom
dmatveev:dm/ocv42_gapi_doc_fixup

Conversation

@dmatveev
Copy link
Copy Markdown
Contributor

@dmatveev dmatveev commented Dec 3, 2019

  • Fixed various typos and missing references;
  • Added brief documentaion on G_TYPED_KERNEL and G_COMPOUND_KERNEL macros;
  • Briefly described GComputationT<>;
  • Briefly described G-API data objects (in a group section);
  • Better document rendering API;
  • Better organized documentation on existing graph compilation arguments.
force_builders=Custom
buildworker:Custom=linux-1
build_image:Custom=ubuntu-gapi-freetype:16.04

build_gapi_standalone:Linux x64=ade-0.1.1f
build_gapi_standalone:Win64=ade-0.1.1f
build_gapi_standalone:Mac=ade-0.1.1f
build_gapi_standalone:Linux x64 Debug=ade-0.1.1f

- Fixed various typos and missing references;
- Added brief documentaion on G_TYPED_KERNEL and G_COMPOUND_KERNEL macros;
- Briefly described GComputationT<>;
- Briefly described G-API data objects (in a group section).
@dmatveev dmatveev added this to the 4.x milestone Dec 3, 2019
@dmatveev
Copy link
Copy Markdown
Contributor Author

dmatveev commented Dec 3, 2019

@TolyaTalamanov @AsyaPronina can you please have a look on this? There's a link to generated HTML documentation on the "Docs" builder.

@dmatveev dmatveev force-pushed the dm/ocv42_gapi_doc_fixup branch from 6afd425 to d1bc8a2 Compare December 3, 2019 19:43
@dmatveev dmatveev force-pushed the dm/ocv42_gapi_doc_fixup branch from 905e570 to 8609e91 Compare December 4, 2019 10:23
{
/*@{*/
std::string path; //!< The path to font file (.ttf)
std::string path; //!< The path to the font file (.ttf)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you remove (.ttf) It's my mistake. Render works with all font formats. Not only TrueType

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you address it on your own in the following #include review?

@TolyaTalamanov
Copy link
Copy Markdown
Contributor

LGTM 👍

@AsyaPronina
Copy link
Copy Markdown
Contributor

LGTM 👍

@alalek alalek merged commit b2b6f52 into opencv:master Dec 6, 2019
@dmatveev
Copy link
Copy Markdown
Contributor Author

dmatveev commented Dec 6, 2019

Thanks!!

a-sajjad72 pushed a commit to a-sajjad72/opencv that referenced this pull request Mar 30, 2023
* G-API: Addressed various documentation issues

- Fixed various typos and missing references;
- Added brief documentaion on G_TYPED_KERNEL and G_COMPOUND_KERNEL macros;
- Briefly described GComputationT<>;
- Briefly described G-API data objects (in a group section).

* G-API: Some clean-ups in doxygen, also a chapter on Render API

* G-API: Expose more graph compilation arguments in the documentation

* G-API: Address documentation review comments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants