Doxygen
tooltip.h
浏览该文件的文档.
1 /******************************************************************************
2  *
3  * Copyright (C) 1997-2020 by Dimitri van Heesch.
4  *
5  * Permission to use, copy, modify, and distribute this software and its
6  * documentation under the terms of the GNU General Public License is hereby
7  * granted. No representations are made about the suitability of this software
8  * for any purpose. It is provided "as is" without express or implied warranty.
9  * See the GNU General Public License for more details.
10  *
11  * Documents produced by Doxygen are derivative works derived from the
12  * input used in their production; they are not affected by this license.
13  *
14  */
15 #ifndef TOOLTIP_H
16 #define TOOLTIP_H
17 
18 #include <memory>
19 
20 class Definition;
22 
23 //! Class that manages the tooltips for a source file
25 {
26  public:
29 
30  /** add a tooltip for a given symbol definition */
31  void addTooltip(CodeOutputInterface &ol,const Definition *d);
32 
33  /** write the list of all collected tooltip to the given outputs */
35 
36  private:
37  class Private;
38  std::unique_ptr<Private> p;
39 };
40 
41 #endif
Definition
The common base class of all entity definitions found in the sources.
Definition: definition.h:76
TooltipManager::~TooltipManager
~TooltipManager()
Definition: tooltip.cpp:43
TooltipManager::p
std::unique_ptr< Private > p
Definition: tooltip.h:37
TooltipManager::TooltipManager
TooltipManager()
Definition: tooltip.cpp:39
CodeOutputInterface
Output interface for code parser.
Definition: outputgen.h:61
TooltipManager::addTooltip
void addTooltip(CodeOutputInterface &ol, const Definition *d)
add a tooltip for a given symbol definition
Definition: tooltip.cpp:54
TooltipManager
Class that manages the tooltips for a source file
Definition: tooltip.h:24
TooltipManager::writeTooltips
void writeTooltips(CodeOutputInterface &ol)
write the list of all collected tooltip to the given outputs
Definition: tooltip.cpp:87
TooltipManager::Private
Definition: tooltip.cpp:33