MAGMA  magma-1.4.0
Matrix Algebra on GPU and Multicore Architectures
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
gendoc.HtmlDoc Class Reference

Public Member Functions

def tag
 
def preamble
 
def epilog
 
def begin_decl
 
def end_decl
 
def ret_type
 
def funcname
 
def begin_purpose
 
def end_purpose
 
def begin_arguments
 
def end_arguments
 
def begin_arg
 
def end_arg
 
def inoutwork
 
def arg_type
 
def begin_arg_desc
 
def arg_desc_line
 
def end_arg_desc
 
def begin_details
 
def end_details
 
def begin_args_decl
 
def end_args_decl
 
def decl_arg
 

Data Fields

 argcount
 

Detailed Description

Definition at line 199 of file gendoc.py.

Member Function Documentation

def gendoc.HtmlDoc.arg_desc_line (   self,
  s 
)

Definition at line 292 of file gendoc.py.

293  def arg_desc_line(self, s):
294  return s + "\n"
def arg_desc_line
Definition: gendoc.py:292
def gendoc.HtmlDoc.arg_type (   self,
  s 
)

Definition at line 286 of file gendoc.py.

References gendoc.HtmlDoc.tag().

287  def arg_type(self, s):
288  return self.tag("em", s)
def arg_type
Definition: gendoc.py:286

Here is the call graph for this function:

def gendoc.HtmlDoc.begin_arg (   self,
  argname 
)

Definition at line 277 of file gendoc.py.

278  def begin_arg(self, argname):
279  return "<li><b>" + argname + "</b>\n"
def begin_arg
Definition: gendoc.py:277
def gendoc.HtmlDoc.begin_arg_desc (   self,
  argname 
)

Definition at line 289 of file gendoc.py.

290  def begin_arg_desc(self, argname):
291  return "<pre>\n"
def begin_arg_desc
Definition: gendoc.py:289
def gendoc.HtmlDoc.begin_args_decl (   self,
  argcount 
)

Definition at line 304 of file gendoc.py.

305  def begin_args_decl(self, argcount):
306  self.argcount = argcount
307  return "<td>(</td>"
def begin_args_decl
Definition: gendoc.py:304
def gendoc.HtmlDoc.begin_arguments (   self,
  s 
)

Definition at line 270 of file gendoc.py.

References gendoc.HtmlDoc.tag().

271  def begin_arguments(self, s):
272  return "<p><h2>%s</h2>\n" % s
273  return self.tag('div class="arguments"', s) + "<ul>\n"
def begin_arguments
Definition: gendoc.py:270

Here is the call graph for this function:

def gendoc.HtmlDoc.begin_decl (   self)

Definition at line 250 of file gendoc.py.

251  def begin_decl(self):
252  return "<table>\n"
def begin_decl
Definition: gendoc.py:250
def gendoc.HtmlDoc.begin_details (   self,
  s 
)

Definition at line 298 of file gendoc.py.

299  def begin_details(self, s):
300  return "<p><h2>%s</h2>\n<pre>\n" % s
def begin_details
Definition: gendoc.py:298
def gendoc.HtmlDoc.begin_purpose (   self,
  s 
)

Definition at line 264 of file gendoc.py.

265  def begin_purpose(self, s):
266  return "<p><h2>%s</h2>\n<pre>\n" % s
def begin_purpose
Definition: gendoc.py:264
def gendoc.HtmlDoc.decl_arg (   self,
  prefix,
  argname 
)

Definition at line 311 of file gendoc.py.

References gendoc.HtmlDoc.tag().

312  def decl_arg(self, prefix, argname):
313  return "<td>" + prefix + " " + self.tag("em", argname) + "<td>\n</tr>\n<tr><td></td><td></td>"
def decl_arg
Definition: gendoc.py:311

Here is the call graph for this function:

def gendoc.HtmlDoc.end_arg (   self,
  argname 
)

Definition at line 280 of file gendoc.py.

281  def end_arg(self, argname):
282  return ""
def gendoc.HtmlDoc.end_arg_desc (   self,
  argname 
)

Definition at line 295 of file gendoc.py.

296  def end_arg_desc(self, argname):
297  return "</pre>\n</li>\n"
def end_arg_desc
Definition: gendoc.py:295
def gendoc.HtmlDoc.end_args_decl (   self)

Definition at line 308 of file gendoc.py.

309  def end_args_decl(self):
310  return "<td>)</td>\n</tr>\n"
def end_args_decl
Definition: gendoc.py:308
def gendoc.HtmlDoc.end_arguments (   self,
  s 
)

Definition at line 274 of file gendoc.py.

275  def end_arguments(self, s):
276  return "</ul>\n"
def end_arguments
Definition: gendoc.py:274
def gendoc.HtmlDoc.end_decl (   self)

Definition at line 253 of file gendoc.py.

254  def end_decl(self):
255  return "</table>\n"
def end_decl
Definition: gendoc.py:253
def gendoc.HtmlDoc.end_details (   self,
  s 
)

Definition at line 301 of file gendoc.py.

302  def end_details(self, s):
303  return "</pre>\n</p>\n"
def end_details
Definition: gendoc.py:301
def gendoc.HtmlDoc.end_purpose (   self,
  s 
)

Definition at line 267 of file gendoc.py.

268  def end_purpose(self, s):
269  return "</pre>\n</p>\n"
def end_purpose
Definition: gendoc.py:267
def gendoc.HtmlDoc.epilog (   self,
  title 
)

Definition at line 245 of file gendoc.py.

246  def epilog(self, title):
247  return """</body>
248 </html>
249 """
def gendoc.HtmlDoc.funcname (   self,
  s 
)

Definition at line 260 of file gendoc.py.

References gendoc.HtmlDoc.tag().

261  def funcname(self, s):
262  return self.tag('b', s) + "</td>"
263  return self.tag('div class="funcname"', s)
def funcname
Definition: gendoc.py:260

Here is the call graph for this function:

def gendoc.HtmlDoc.inoutwork (   self,
  s 
)

Definition at line 283 of file gendoc.py.

284  def inoutwork(self, s):
285  return s + "\n"
def inoutwork
Definition: gendoc.py:283
def gendoc.HtmlDoc.preamble (   self,
  title 
)

Definition at line 203 of file gendoc.py.

204  def preamble(self, title):
205  return """<html>
206 <head>
207 <title>%s</title>
208 <style>
209 b {
210 font-family: sans-serif;
211 color: red;
212 }
213 em {
214 font-family: sans-serif;
215 color: blue;
216 }
217 table {
218 white-space: nowrap;
219 font-weight: bold;
220 margin-left: 6px;
221 border-top: 1px solid #A8B8D9;
222 border-left: 1px solid #A8B8D9;
223 border-right: 1px solid #A8B8D9;
224 padding: 6px 0px 6px 0px;
225 color: #253555;
226 font-weight: bold;
227 text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
228 /* firefox specific markup */
229 -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
230 -moz-border-radius-topright: 8px;
231 -moz-border-radius-topleft: 8px;
232 /* webkit specific markup */
233 -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
234 -webkit-border-top-right-radius: 8px;
235 -webkit-border-top-left-radius: 8px;
236 background-image:url('nav_f.png');
237 background-repeat:repeat-x;
238 background-color: #E2E8F2;
239 }
240 pre {background: #ffffee; border: 1px solid silver; padding: 0.5em;}
241 </style>
242 </head>
243 <body>
244 """ % title
def preamble
Definition: gendoc.py:203
def gendoc.HtmlDoc.ret_type (   self,
  s 
)

Definition at line 256 of file gendoc.py.

References gendoc.HtmlDoc.tag().

257  def ret_type(self, s):
258  return "<tr><td>" + s + " "
259  return self.tag('div class="ret_type"', s)
def ret_type
Definition: gendoc.py:256

Here is the call graph for this function:

def gendoc.HtmlDoc.tag (   self,
  tag,
  s 
)

Definition at line 200 of file gendoc.py.

201  def tag(self, tag, s):
202  return "<" + tag + ">" + s + "</" + tag.split()[0] + ">\n"

Here is the caller graph for this function:

Field Documentation

gendoc.HtmlDoc.argcount

Definition at line 305 of file gendoc.py.


The documentation for this class was generated from the following file: