String - Documentation and API changes

[ahueck]

Overview

This is an attempt to start to streamline the documentation of the cmake/string function folder. At the same time, the corresponding tests were created/extended/streamlined in order to ensure a more thorough testing.

What was added:

• Comments what each function does and specifying the type of input and output
• Create a reasonable unit test base line
• Bug fixes due to testing

  TODO

• Validate the documentation: errors, form
• Validate that the changed API has no further side effects
• Finish the documentation. A few functions are missing.

  Caveat

For a few functions, the order of the parameters were changed (hence the API changes). I tried to update the calls and tests seemingly work (cmake -P cmakepp.cmake test_execute_globparallel "tests//_.cmake"). However, executing "cmake -P build/script.cmake" fails (same as the master itself?)

[toeb]

thanks alot :smile:

[toeb]

Hi Again,

Please also generate the Documentation using the sublime build system build cmakepp documentation and look if it renders correctly (you can use the markdown preview plugin for sublime - look for it in the package control)

I noticed that your documentation while very good does not have any fenced code blocks for examples. Because of that the layout is destroyed when rendererd as markdown.

please add them were necessary

    ```cmake
    some_cmake_function(arg1 arg2) # comment

also see https://guides.github.com/features/mastering-markdown/  for formatting options