Consistency in namespace-closing comments
[folly.git] / folly / init / Init.h
1 /*
2  * Copyright 2017 Facebook, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *   http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #pragma once
18
19 /*
20  * Calls common init functions in the necessary order
21  * Among other things, this ensures that folly::Singletons are initialized
22  * correctly and installs signal handlers for a superior debugging experience.
23  * It also initializes gflags and glog.
24  *
25  * @param argc, argv   arguments to your main
26  * @param removeFlags  if true, will update argc,argv to remove recognized
27  *                     gflags passed on the command line
28  */
29 namespace folly {
30
31 void init(int* argc, char*** argv, bool removeFlags = true);
32
33 } // namespace folly