Method: YARD::Server::LibraryVersion#yardoc_file

Defined in:
lib/yard/server/library_version.rb

#yardoc_file ⇒ String?

Note:

To implement a custom yardoc file getter, implement

Returns:

  • (String) —

    the location of the yardoc file used to load the object information from.

  • (nil) —

    if no yardoc file exists yet. In this case, #prepare! will be called on this library to build the yardoc file.

Since:

  • 0.6.0



106
107
108
 
# File 'lib/yard/server/library_version.rb', line 106

def yardoc_file
  @yardoc_file ||= load_yardoc_file
end