HoverRace  2.0
HelpHandler.h
Go to the documentation of this file.
1 
2 // HelpHandler.h
3 //
4 // Copyright (c) 2010, 2016 Michael Imamura.
5 //
6 // Licensed under GrokkSoft HoverRace SourceCode License v1.0(the "License");
7 // you may not use this file except in compliance with the License.
8 //
9 // A copy of the license should have been attached to the package from which
10 // you have taken this file. If you can not find the license you can not use
11 // this file.
12 //
13 //
14 // The author makes no representations about the suitability of
15 // this software for any purpose. It is provided "as is" "AS IS",
16 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
17 // implied.
18 //
19 // See the License for the specific language governing permissions
20 // and limitations under the License.
21 
22 #pragma once
23 
24 #if defined(_WIN32) && defined(HR_ENGINE_SHARED)
25 # ifdef MR_ENGINE
26 # define MR_DllDeclare __declspec( dllexport )
27 # else
28 # define MR_DllDeclare __declspec( dllimport )
29 # endif
30 #else
31 # define MR_DllDeclare
32 #endif
33 
34 namespace HoverRace {
35 namespace Script {
36 namespace Help {
37 
38 class Class;
39 class Method;
40 
46 public:
47  virtual void HelpClass(const Class &cls) = 0;
48  virtual void HelpMethod(const Class &cls, const Method &method) = 0;
49 };
50 
51 } // namespace Help
52 } // namespace Script
53 } // namespace HoverRace
54 
55 #undef MR_DllDeclare
#define MR_DllDeclare
Definition: HelpHandler.h:31
Abstract base class for handlers of help requests.
Definition: HelpHandler.h:45
API documentation for a Lua method.
Definition: Method.h:50
API documentation for a Lua class.
Definition: Class.h:52
Definition: Announcement.h:24