Skip to content

CtrlppCheck synopsis vs. functionality #104

@hfrmobile

Description

@hfrmobile

Describe the bugs

Ctrlppcheck - A tool for static Ctrl/Ctrl++ code analysis

Syntax:
    cppcheck [OPTIONS] [files or paths]

If a directory is given instead of a filename, *.ctl files are
 checked recursively from the given directory.

Options:
  Mandatory:
    --winccoa-projectName=PROJ_NAME
    --winCCOA-productCode=WinCCOA_PRODUCT_CODE

To Reproduce
Run ctrlppcheck SomeClass.ctl --winccoa-projectName=DEVharry_320 (it works without --winCCOA-productCode (so, not mandatory)). Btw., why mixing casing? Also Missing the information what "WinCCOA_PRODUCT_CODE" is.

Expected behavior
Show/describe --winCCOA-productCode not as mandatory. Show/describe what WinCCOA_PRODUCT_CODE is,

Example usage:
  # Recursively check the current folder. Print the progress on the screen and
  # write errors to a file:
  cppcheck . 2> err.txt

  # Recursively check ../myproject/ and don't print progress:
  cppcheck --quiet ../myproject/

  # Check test.ctl, enable all checks:
  cppcheck --enable=all --inconclusive test.ctl

  # Check f.ctl and search include files from inc1/ and inc2/:
  cppcheck -I inc1/ -I inc2/ f.ctl

To Reproduce
Run ctrlppcheck without parameters

Expected behavior
Given examples are for cppcheck, not for CtrlPPcheck...

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions