File: Mainpage.dox

package info (click to toggle)
grantlee5 5.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 4,028 kB
  • sloc: cpp: 24,265; javascript: 6,043; python: 299; sh: 109; ruby: 24; makefile: 15
file content (96 lines) | stat: -rw-r--r-- 2,567 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

// Put this in the Grantlee namespace so that autolinks to classes work without needing a Grantlee:: prefix.

/**
  @brief The Grantlee namespace holds all public %Grantlee API.
*/
namespace Grantlee
{

/** @mainpage The Grantlee Libraries

  @section overview Overview

  %Grantlee is a Free Software, Open Source set of Qt based libraries used for text processing.

  The text template is modelled after the [Django template system](https://docs.djangoproject.com/en/1.9/ref/templates/language/):

  @code
    <ul>
    {% for athlete in athlete_list %}
    <li>{{ athlete.name }}{% if athlete.isCaptain %} (C){% endif %}</li>
    {% endfor %}
    </ul>
  @endcode

  %Grantlee is covered by the GNU Lesser General Public Licence version 2.1 or, at your option, any later version.

  <table class="main_api" >
    <tr><th class="library" colspan="3">%Grantlee Templates</th></tr>
    <tr><th class="section" >Application API</th><th class="section">%Plugin API</th><th class="section">Guides</th></tr>
    <tr><td>
      - AbstractLocalizer
      - AbstractTemplateLoader
      - CachingLoaderDecorator
      - Context
      - Engine
      - FileSystemTemplateLoader
      - InMemoryTemplateLoader
      - OutputStream
      - QtLocalizer
      - Template
    </td><td>
      - AbstractNodeFactory
      - Exception
      - Filter
      - FilterExpression
      - Node
      - NodeList
      - Parser
      - RenderContext
      - SafeString
      - TagLibraryInterface
      - Variable
    </td><td>
      - @ref for_themers
      - @ref for_app_dev
      - @ref builtins
      - @ref extension
      - @ref examples
      - @ref differences_django
      - @ref using_and_deploying
      - @ref internals
      - @ref generic_types_and_templates
      - @ref i18n_l10n
      - @ref porting_from_qt4
    </td></tr>
      <tr><th class="library" colspan="3">%Grantlee TextDocument</th></tr>
    <tr><td colspan="2">
      - AbstractMarkupBuilder
      - MarkupDirector
      - TextHTMLBuilder
      - PlainTextMarkupBuilder
    </td><td>
      - @ref custom_qtextobject
    </td></tr>
  </table>
  <br />

  <center>
  <b>
  @dotfile "moduledeps.dot" "Dependency Graph for Grantlee"
  </b>
  </center>

  @section start_community Community

  The %Grantlee project mailing list is kde-pim@kde.org, and the IRC channel is \#grantlee on freenode.

  The source repository is located at https://github.com/steveire/grantlee

  - Existing bugs https://bugs.kde.org/buglist.cgi?product=grantlee
  - File new bug https://bugs.kde.org/enter_bug.cgi?product=grantlee

*/

}