___ _ _ ____ / | __________(_|_) __ \____ _ ____ __ / /| | / ___/ ___/ / / / / / __ \| |/_/ / / / / ___ |(__ ) /__/ / / /_/ / /_/ /> </ /_/ / /_/ |_/____/\___/_/_/_____/\____/_/|_|\__, / /____/
[ Home | What is AsciiDoxy? | Getting started | Reference documentation | Examples | Contributing | Changelog | GitHub ]
Python
This example shows documentation for a python project.
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
# into which the generated documentation will be written. If a relative path is
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = $(OUTPUT_DIR)
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
# The default value is: YES.
GENERATE_HTML = NO
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = NO
# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
# captures the structure of the code including all documentation.
# The default value is: NO.
GENERATE_XML = YES
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.
RECURSIVE = YES
# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the
# filter if there is a match. The filters are a list of the form: pattern=filter
# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
# patterns match the file name, INPUT_FILTER is applied.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.
# Using a local copy of doxypypy until https://github.com/Feneric/doxypypy/issues/70 is solved
FILTER_PATTERNS = *.py="python3 ../../doxypypy.py -a -c"
${insert("geometry.Coordinate")}
Coordinate
class geometry.Coordinate
Class to hold information about a coordinate.
A coordinate has a latitude, longitude, and an altitude.
Constructors |
|
---|---|
Variables |
|
Static methods |
|
Methods |
|
Members
init
def __init__(self)
latitude
Latitude in degrees.
longitude
Longitude in degrees.
altitude
Altitude in meters.
combine
def combine(left: Coordinate,
right: Coordinate) -> Coordinate
Combine two coordinates.
Parameters |
|
---|---|
Returns |
is_valid
def is_valid(self) -> bool
Check if the coordinate is valid.
A coordinate is valid if its values are within WGS84 bounds.
Returns |
|
---|
from_string
def from_string(cls,
value: str) -> Coordinate
Create a coordinate from its string representation.
Parameters |
|
---|---|
Returns |
from_string_safe
def from_string_safe(cls,
value: Optional[str]) -> Optional[Coordinate]
Create a coordinate from its string representation.
Accepts None as input.
Parameters |
|
---|---|
Returns |
|