Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / depsgraph / intern / eval / deg_eval.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2013 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup depsgraph
21  *
22  * Evaluation engine entrypoints for Depsgraph Engine.
23  */
24
25 #pragma once
26
27 namespace DEG {
28
29 struct Depsgraph;
30
31 /**
32  * Evaluate all nodes tagged for updating,
33  * \warning This is usually done as part of main loop, but may also be
34  * called from frame-change update.
35  *
36  * \note Time sources should be all valid!
37  */
38 void deg_evaluate_on_refresh(Depsgraph *graph);
39
40 }  // namespace DEG