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
|
#
# Copyright (C) 2000 Stephen Davies
# Copyright (C) 2000 Stefan Seefeld
# All rights reserved.
# Licensed to the public under the terms of the GNU LGPL (>= 2),
# see the file COPYING for details.
#
from Synopsis.Processor import Parametrized, Parameter
from Synopsis import AST, Type, Util
class Formatter(Parametrized):
"""Interface class that takes a comment and formats its summary and/or
detail strings."""
def init(self, processor):
self.processor = processor
def format(self, view, decl, text):
"""Format the given comment
@param view the View to use for references and determining the correct
relative filename.
@param decl the declaration
@param text the comment text to format
"""
return text
def format_summary(self, view, decl, text):
"""Format the given comment summary
@param view the View to use for references and determining the correct
relative filename.
@param decl the declaration
@param summary the comment summary to format
"""
return text
|
