ImFusion C++ SDK 4.4.0
ImFusion::UserDocumentation::AlgorithmDoc Struct Reference

#include <ImFusion/GUI/UserDocumentation.h>

Record of the common sections for Algorithm User Documentation. More...

Detailed Description

Record of the common sections for Algorithm User Documentation.

Public Attributes

std::string summary
 Brief summary.
std::string input
 Textual description of the algorithm input.
std::string output
 Textual description of the algorithm output.
std::string description
 Full algorithm description.
Filesystem::Path htmlPage
 Path to generated HTML page.
std::set< std::stringsearchWords
 Words to be used for search indexing.

The documentation for this struct was generated from the following file:
  • ImFusion/GUI/UserDocumentation.h
Search Tab / S to search, Esc to close