KSSContract Documentation

Using the library

Accessing the header files

The recommended way to use this library (unless you embedded it directly into your code) is to include the all.h header file. This will include all the public headers and has two advantages over including them individually:

1. You don't have to remember all the individual filenames, andd
2. using all.h allows the compiler to make better use of precompiled headers.

So, the typical include would be

#include <kss/contract/all.h>

You can include the individual headers separately if you really want to, but note that you will still need to include the "kss/contract" prefix for each of them, even though that is not reported in the Doxygen generated documentation.

Accessing the library file

The created library will always be a dynamic library called ksstest. Hence you would add

-lksscontract

to your build.

License

Unless otherwise specified, the files in this library are licensed according to the MIT license as shown below.

MIT License
 
Copyright (c) 2019 Klassen Software Solutions
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.