Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • otb otb
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 212
    • Issues 212
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 13
    • Merge requests 13
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Artifacts
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Container Registry
    • Model experiments
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Main Repositories
  • otbotb
  • Issues
  • #1904

Improve BandMathX documentation

The documentation of BandMathX in the Cookbook is a bit confusing:

  • There is the application documentation: the documentation is quite long but non exhaustive.
  • There is the About BandMathX C++ API section. It contains information on the BandMathX syntax and C++ example. It contains a lot of details on advanced use of BandMathX, and describes additional functionalities beside MuParserX. This section comes from the Software Guide migration.
  • Document bit manipulation as it should be used with the int operator

Most users of BandMathX are using the application, and will never open the C++ API section. I think the documentation should be refactored as follow:

  • All the syntax related information should go in BandMathX's documentation.
  • The About BandMathX C++ API section should be removed, and the C++ part should be moved to the examples (or not, there is already an example for the BandMathX filter).
  • We could add an example of the BandMathX application in this recipe, to point out the differences with BandMath
Edited Jul 22, 2019 by Antoine Regimbeau
Assignee
Assign to
Time tracking