File: SummaryCommenter.py

package info (click to toggle)
synopsis 0.8.0-5
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 10,112 kB
  • ctags: 12,996
  • sloc: cpp: 34,254; ansic: 33,620; python: 10,975; sh: 7,261; xml: 6,369; makefile: 773; asm: 445
file content (29 lines) | stat: -rw-r--r-- 818 bytes parent folder | download | duplicates (2) 
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
 
#
# 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.Formatters.HTML.Tags import *
from Default import Default

class SummaryCommenter(Default):
   """Adds summary comments to all declarations"""

   def format_declaration(self, decl):
      summary = self.processor.comments.format_summary(self.view, decl)
      if summary:
         return '<br/>\n'+span('summary', summary)
      return ''

   def format_group(self, decl):
      """Override for group to use the div version of commenting, and no
      <br/> before"""

      summary = self.processor.comments.format(self.view, decl)
      if summary:
         return desc(summary)
      return ''