siemens / CtrlppCheck

GNU General Public License v3.0
14 stars 11 forks source link

CtrlppCheck synopsis vs. functionality #104

Open hfrmobile opened 10 months ago

hfrmobile commented 10 months ago

Describe the bugs

1)

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,

2)

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...