Class: File

Defined in: src/nodes/file.coffee
Inherits: Class

Overview

The file class is a fake class that wraps the

Instance Method Summary

Inherited Method Summary

Methods inherited from Class

.constructor, .getFileName, .getDoc, .getFullName, .getClassName, .getName, .getLocation, .getNamespace, .getParentClassName, .getMethods, .getVariables, .toJSON

Methods inherited from Node

.findAncestor

Constructor Details

.constructor(node, fileName, lineMapping, options)

Construct a File object.

Parameters:

  • (Object) nodeThe class node (a {Object})
  • (String) filenameA {String} representing the current filename
  • lineMappingAn object mapping the actual position of a member to its Biscotto one
  • optionsAny additional parser options

Instance Method Details

String .getFileName()

Returns the file class name.

Returns:

  • (String) — Returns the file name without path as a {String}.

String .getFullName()

Get the full file name with path

Returns:

  • (String) — Returns the file name with path as a {String}.

String .getPath()

Get the file path

Returns:

  • (String) — Returns the file path as a {String}.

.isEmpty()

Test if the file doesn't contain any top-level public methods.

Returns:

  • Returns true if empty.

Object .toJSON()

Get a JSON representation of the object

Returns:

  • (Object) — Returns the JSON object (a {Object}).