From 7b8d12e50b5b5491dce7feb6576f53b8c1ccb216 Mon Sep 17 00:00:00 2001 From: Michael Platings Date: Wed, 14 Feb 2024 18:42:57 +0000 Subject: [PATCH] Document that semantic versioning shall be used The first rule of semver is that a public API shall be declared, so document what constitutes the IntrinsicCV public API. --- intrinsiccv/include/intrinsiccv/intrinsiccv.h | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/intrinsiccv/include/intrinsiccv/intrinsiccv.h b/intrinsiccv/include/intrinsiccv/intrinsiccv.h index bea02524a..e1a59e75a 100644 --- a/intrinsiccv/include/intrinsiccv/intrinsiccv.h +++ b/intrinsiccv/include/intrinsiccv/intrinsiccv.h @@ -8,6 +8,12 @@ /// /// Project page: https://gitlab.arm.com/intrinsiccv/intrinsiccv /// +/// IntrinsicCV shall use Semantic +/// Versioning 2.0.0. The public API is defined according to what is +/// included in the Doxygen-generated documentation as well as the content of +/// the project's Markdown files. Features without such documentation are not +/// part of the public API and should not be relied upon. +/// /// @see Code Coverage Report /// @file -- GitLab