|
From: Doug H. <dou...@us...> - 2002-02-02 13:46:30
|
Update of /cvsroot/happydoc/HappyDoc/happydoclib/formatter
In directory usw-pr-cvs1:/tmp/cvs-serv9141/happydoclib/formatter
Modified Files:
fileformatterbase.py
Log Message:
Added more documentation.
Index: fileformatterbase.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc/happydoclib/formatter/fileformatterbase.py,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** fileformatterbase.py 2001/11/11 18:53:44 1.4
--- fileformatterbase.py 2002/02/02 13:46:27 1.5
***************
*** 111,115 ****
def fixUpOutputFilename(self, filename):
! """Tweak the filename to remove relative references and add the safe prefix."""
#
# Remove preceding slashes to make name relative
--- 111,121 ----
def fixUpOutputFilename(self, filename):
! """Tweak the filename to remove relative references
! and add the safe prefix.
!
! Returns a relative path, but without the ./ or ../ at the
! front. This path will then, usually, be tacked on the end of
! the output path to create a full path.
! """
#
# Remove preceding slashes to make name relative
***************
*** 125,133 ****
def getOutputNameForFile(self, filename):
! """
! Return the base name of the thing to which output should be
! written for a file. This is usually a file name, but could be
! anything understood by the formatter as a name. If infoObject
! is None, return the name for a root node for this formatter.
"""
happydoclib.TRACE.into('FileBasedFormatter', 'getOutputNameForFile',
--- 131,140 ----
def getOutputNameForFile(self, filename):
! """Return the base name of the thing to which output should be
! written for a file.
!
! This is usually a file name, but could be anything understood
! by the formatter as a name. If infoObject is None, return the
! name for a root node for this formatter.
"""
happydoclib.TRACE.into('FileBasedFormatter', 'getOutputNameForFile',
***************
*** 146,155 ****
def getOutputNameForObject(self, infoObject):
! """
! Return the base name of the thing to which output should be written
! for an info source. This is usually a file name, but could
! be anything understood by the formatter as a name. If
! infoObject is None, return the name for a root node for this
! formatter.
"""
happydoclib.TRACE.into('FileBasedFormatter', 'getOutputNameForObject',
--- 153,162 ----
def getOutputNameForObject(self, infoObject):
! """Return the base name of the thing to which output should be written
! for an info source.
!
! This is usually a file name, but could be anything understood
! by the formatter as a name. If infoObject is None, return the
! name for a root node for this formatter.
"""
happydoclib.TRACE.into('FileBasedFormatter', 'getOutputNameForObject',
***************
*** 173,182 ****
def getLocalOutputNameForObject(self, infoObject):
! """
! Return a local reference to base name of the thing to which
! output should be written for an info source. This is usually
! a file name, but could be anything understood by the formatter
! as a name. If infoObject is None, return the name for a root
! node for this formatter.
"""
extension = self.getFilenameExtension()
--- 180,189 ----
def getLocalOutputNameForObject(self, infoObject):
! """Return a local reference to base name of the thing to which
! output should be written for an info source.
!
! This is usually a file name, but could be anything understood
! by the formatter as a name. If infoObject is None, return the
! name for a root node for this formatter.
"""
extension = self.getFilenameExtension()
***************
*** 190,194 ****
def getFullOutputNameForObject(self, infoObject):
! "Get the full name, including path, to the object being output."
happydoclib.TRACE.into('FileBasedFormatter', 'getFullOutputNameForObject',
infoObject=infoObject)
--- 197,206 ----
def getFullOutputNameForObject(self, infoObject):
! """Get the full name, including path, to the object being output.
!
! The prefix of the return value should be the output path for
! all documentation. The rest of the return value will be based
! on the path to the source for the object.
! """
happydoclib.TRACE.into('FileBasedFormatter', 'getFullOutputNameForObject',
infoObject=infoObject)
|
