File indexing completed on 2024-04-28 16:01:32

0001 /******************************************************************************
0002  * This file is part of the libqgit2 library
0003  *
0004  * This library is free software; you can redistribute it and/or
0005  * modify it under the terms of the GNU Lesser General Public
0006  * License as published by the Free Software Foundation; either
0007  * version 2.1 of the License, or (at your option) any later version.
0008  *
0009  * This library is distributed in the hope that it will be useful,
0010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0012  * Lesser General Public License for more details.
0013  *
0014  * You should have received a copy of the GNU Lesser General Public
0015  * License along with this library; if not, write to the Free Software
0016  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
0017  */
0018 
0019 #ifndef LIBQGIT2_GLOBAL_H
0020 #define LIBQGIT2_GLOBAL_H
0021 
0022 #include "libqgit2_export.h"
0023 
0024 namespace LibQGit2
0025 {
0026     /**
0027      * This method should be called once before using any other parts of LibQGit2.
0028      *
0029      * This method can be called more than once - the subsequent calls have no extra
0030      * effect. But note that the \c shutdownLibQGit2() method should be called (at least)
0031      * as many times as \c initLibQGit2() has been called.
0032      *
0033      * @return true when the initialization happens.
0034      */
0035     LIBQGIT2_EXPORT bool initLibQGit2();
0036 
0037     /**
0038      * This method should be called when done with LibQGit2.
0039      *
0040      * This method must be called (at least) as many times as \c initLibQGit2() has been
0041      * called. Only after the same amount of calls have been made to this method the
0042      * library actually gets uninitialized.
0043      *
0044      * @return true when the shutdown happens.
0045      */
0046     LIBQGIT2_EXPORT bool shutdownLibQGit2();
0047 }
0048 
0049 #endif // LIBQGIT2_GLOBAL_H