From eb58385cf476de8668d981621085933189ae3906 Mon Sep 17 00:00:00 2001 From: Brenno Date: Sat, 8 Aug 2020 18:50:47 -0300 Subject: [PATCH] Improved documentation --- include/CVTracker.h | 30 ++++++++++++++++++++++++++++++ include/ProcessingController.h | 30 ++++++++++++++++++++++++++++++ 2 files changed, 60 insertions(+) diff --git a/include/CVTracker.h b/include/CVTracker.h index c5c18aee1..549a05db4 100644 --- a/include/CVTracker.h +++ b/include/CVTracker.h @@ -1,3 +1,33 @@ +/** + * @file + * @brief Track an object selected by the user + * @author Jonathan Thomas + * + * @ref License + */ + +/* LICENSE + * + * Copyright (c) 2008-2019 OpenShot Studios, LLC + * . This file is part of + * OpenShot Library (libopenshot), an open-source project dedicated to + * delivering high quality video editing and animation solutions to the + * world. For more information visit . + * + * OpenShot Library (libopenshot) is free software: you can redistribute it + * and/or modify it under the terms of the GNU Lesser General Public License + * as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * OpenShot Library (libopenshot) is distributed in the hope that it will be + * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with OpenShot Library. If not, see . + */ + #ifndef OPENSHOT_CVTRACKER_H #define OPENSHOT_CVTRACKER_H diff --git a/include/ProcessingController.h b/include/ProcessingController.h index 05e24e18c..6071ee88a 100644 --- a/include/ProcessingController.h +++ b/include/ProcessingController.h @@ -1,3 +1,33 @@ +/** + * @file + * @brief This is a message class for thread safe comunication between ClipProcessingJobs and OpenCV classes + * @author Jonathan Thomas + * + * @ref License + */ + +/* LICENSE + * + * Copyright (c) 2008-2019 OpenShot Studios, LLC + * . This file is part of + * OpenShot Library (libopenshot), an open-source project dedicated to + * delivering high quality video editing and animation solutions to the + * world. For more information visit . + * + * OpenShot Library (libopenshot) is free software: you can redistribute it + * and/or modify it under the terms of the GNU Lesser General Public License + * as published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * OpenShot Library (libopenshot) is distributed in the hope that it will be + * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with OpenShot Library. If not, see . + */ + #ifndef OPENSHOT_PROCESSINGCONTROLLER_H #define OPENSHOT_PROCESSINGCONTROLLER_H