documentation.yml

plugin:
  - documentation-polyglot
  - ../../../../scripts/documentation-async.js

shallow: true

sortOrder:
  - kind:
    - namespace
    - class
    - interface
    - typedef
    - enum
    - constant
    - property
    - member
    - function
  - memberof
  - alpha

defaultGlobals: false

toc:
  - name: gdal
    file: gdal-async.md
  - name: Major Objects
    description: Classes for GDAL Major Objects
    children:
      - open
      - openAsync
      - Dataset
      - DatasetBands
      - Driver
      - GDALDrivers
      - RasterBand
      - RasterBandPixels
      - RasterBandOverviews
      - ColorTable
      - Layer
      - DatasetLayers
      - SpatialReference
      - CoordinateTransformation

  - name: Features
    description: Classes for working with vector features
    children:
      - LayerFields
      - LayerFeatures
      - Feature
      - FeatureDefn
      - FeatureDefnFields
      - FeatureFields
      - FieldDefn

  - name: Geometries
    description: Classes representing vector geometries
    children:
      - Geometry
      - GeometryCollection
      - GeometryCollectionChildren
      - CircularString
      - CompoundCurve
      - CompoundCurveCurves
      - LinearRing
      - LineString
      - LineStringPoints
      - MultiCurve
      - MultiLineString
      - MultiPoint
      - MultiPolygon
      - Point
      - Polygon
      - PolygonRings
      - SimpleCurve
      - Envelope
      - Envelope3D

  - name: Multi-Dimensional Model
    description: Classes for working with the Multi-Dimensional Data Model
    children:
      - ArrayAttributes
      - ArrayDimensions
      - Attribute
      - Dimension
      - Group
      - GroupArrays
      - GroupAttributes
      - GroupDimensions
      - GroupGroups
      - MDArray

  - name: Streams
    description: Raster Data Integration with Node.js Streams
    children:
      - RasterMuxStream
      - RasterReadStream
      - RasterTransform
      - RasterWriteStream

  - name: Constants
    description: All constants
    children:
      - name: CPL Error Codes
        children:
          - CE_Debug
          - CE_Failure
          - CE_Fatal
          - CE_None
          - CE_Warning
          - CPLE_AppDefined
          - CPLE_AssertionFailed
          - CPLE_FileIO
          - CPLE_IllegalArg
          - CPLE_None
          - CPLE_NotSupported
          - CPLE_NoWriteAccess
          - CPLE_objectNull
          - CPLE_OpenFailed
          - CPLE_OutOfMemory
          - CPLE_UserInterrupt
      - name: Dataset creation
        children:
          - DCAP_CREATE
          - DCAP_CREATECOPY
          - DCAP_VIRTUALIO
      - name: Dimensions
        children:
          - DIM_HORIZONTAL_X
          - DIM_HORIZONTAL_Y
          - DIM_PARAMETRIC
          - DIM_TEMPORAL
          - DIM_VERTICAL
          - DIR_DOWN
          - DIR_EAST
          - DIR_FUTURE
          - DIR_NORTH
          - DIR_PAST
          - DIR_SOUTH
          - DIR_UP
          - DIR_WEST
      - name: DMD
        children:
          - DMD_CREATIONDATATYPES
          - DMD_CREATIONOPTIONLIST
          - DMD_EXTENSION
          - DMD_HELPTOPIC
          - DMD_LONGNAME
          - DMD_MIMETYPE
      - name: IO Flags
        children:
          - GA_Readonly
          - GA_Update
          - GF_Read
          - GF_Write
      - name: Color Interpretation
        children:
          - GCI_AlphaBand
          - GCI_BlackBand
          - GCI_BlueBand
          - GCI_CyanBand
          - GCI_GrayIndex
          - GCI_GreenBand
          - GCI_HueBand
          - GCI_LightnessBand
          - GCI_MagentaBand
          - GCI_PaletteIndex
          - GCI_RedBand
          - GCI_SaturationBand
          - GCI_Undefined
          - GCI_YCbCr_CbBand
          - GCI_YCbCr_CrBand
          - GCI_YCbCr_YBand
          - GCI_YellowBand
          - GPI_CMYK
          - GPI_Gray
          - GPI_HLS
          - GPI_RGB
      - name: Pixel Types
        children:
          - GDT_Byte
          - GDT_CFloat32
          - GDT_CFloat64
          - GDT_CInt16
          - GDT_CInt32
          - GDT_Float32
          - GDT_Float64
          - GDT_Int16
          - GDT_Int32
          - GDT_UInt16
          - GDT_UInt32
          - GDT_Unknown
          - GEDTC_Compound
          - GEDTC_String
      - name: Resampling Algorithms
        children:
          - GRA_Average
          - GRA_Bilinear
          - GRA_Cubic
          - GRA_CubicSpline
          - GRA_Lanczos
          - GRA_Mode
          - GRA_NearestNeighbor
      - name: ODsCC
        children:
          - ODrCCreateDataSource
          - ODrCDeleteDataSource
          - ODsCCreateGeomFieldAfterCreateLayer
          - ODsCCreateLayer
          - ODsCDeleteLayer
      - name: Feature Field Types
        children:
          - OFTBinary
          - OFTDate
          - OFTDateTime
          - OFTInteger
          - OFTInteger64
          - OFTInteger64List
          - OFTIntegerList
          - OFTReal
          - OFTRealList
          - OFTString
          - OFTStringList
          - OFTTime
          - OFTWideString
          - OFTWideStringList
      - name: Justification
        children:
          - OJLeft
          - OJRight
          - OJUndefined
      - name: OLC
        children:
          - OLCAlterFieldDefn
          - OLCCreateField
          - OLCCreateGeomField
          - OLCDeleteFeature
          - OLCDeleteField
          - OLCFastFeatureCount
          - OLCFastGetExtent
          - OLCFastSetNextByIndex
          - OLCFastSpatialFilter
          - OLCIgnoreFields
          - OLCRandomRead
          - OLCRandomWrite
          - OLCReorderFields
          - OLCSequentialWrite
          - OLCStringsAsUTF8
          - OLCTransactions
      - name: wkbGeometryType
        children:
          - wkb25DBit
          - wkbCircularString
          - wkbCompoundCurve
          - wkbGeometryCollection
          - wkbGeometryCollection25D
          - wkbLinearRing
          - wkbLinearRing25D
          - wkbLineString
          - wkbLineString25D
          - wkbMultiCurve
          - wkbMultiLineString
          - wkbMultiLineString25D
          - wkbMultiPoint
          - wkbMultiPoint25D
          - wkbMultiPolygon
          - wkbMultiPolygon25D
      - name: wkbByteOrder
        children:
          - wkbNDR
          - wkbXDR
          - wkbNone
          - wkbPoint
          - wkbPoint25D
          - wkbPolygon
          - wkbPolygon25D
          - wkbUnknown
      - name: wkbVariant
        children:
          - wkbVariantIso
          - wkbVariantOgc
          - wkbVariantOldOgc

  - name: Data Types
    children:
      - forEachCb
      - mapCb
      - callback
      - stats
      - units
      - xyz
      - RasterReadableOptions
      - RasterWritableOptions
      - RasterTransformOptions
      - CalcOptions
      - ContourOptions
      - CreateOptions
      - FillOptions
      - MDArrayOptions
      - PixelFunction
      - PolygonizeOptions
      - ProgressCb
      - ProgressOptions
      - ReprojectOptions
      - SieveOptions
      - StringOptions
      - UtilOptions
      - VRTBandDescriptor
      - VRTDescriptor
      - WarpOptions
      - WarpOutput

  - name: Global Parameters
    children:
      - version
      - bundled
      - drivers
      - lastError
      - verbose
      - eventLoopWarning

  - name: Utilities
    children:
      - addPixelFunc
      - buildVRT
      - buildVRTAsync
      - calcAsync
      - checksumImage
      - checksumImageAsync
      - contourGenerate
      - contourGenerateAsync
      - createPixelFunc
      - createPixelFuncWithArgs
      - decToDMS
      - dem
      - demAsync
      - fillNodata
      - fillNodataAsync
      - fromDataType
      - info
      - infoAsync
      - polygonize
      - polygonizeAsync
      - quiet
      - rasterize
      - rasterizeAsync
      - reprojectImage
      - reprojectImageAsync
      - setPROJSearchPaths
      - sieveFilter
      - sieveFilterAsync
      - suggestedWarpOutput
      - suggestedWarpOutputAsync
      - toDataType
      - toPixelFunc
      - translate
      - translateAsync
      - vectorTranslate
      - vectorTranslateAsync
      - warp
      - warpAsync
      - wrapVRT

documentation-polyglot:
  extensions: [ .cpp, .hpp, .h ]
  infer:
    kind:
      function: [ NAN_METHOD\(.+\), GDAL_ASYNCABLE_DEFINE\(.+\), NODE_WRAPPED_METHOD.+\(.+\) ]
      property: [ NAN_GETTER\(.+\), GDAL_ASYNCABLE_GETTER_DECLARE\(.+\) ]
    name:
      - NAN_METHOD\s*\(.+::([a-zA-Z0-9_]+)\)
      - NAN_METHOD\s*\(([a-zA-Z0-9_]+)\)
      - GDAL_ASYNCABLE_DEFINE\s*\(.+::([a-zA-Z0-9_]+)\)
      - NODE_WRAPPED_METHOD_.+\(.+,\s*(.+),\s*.+,\s*.+,\s*.+,\s*.+,\s*\)
      - NAN_GETTER\s*\(.+::([a-zA-Z0-9_]+)\)
      - GDAL_ASYNCABLE_GETTER_DECLARE\s*\(.+::([a-zA-Z0-9_]+)\)

documentation-hipster:
  crossLinksDupeWarning: false
  srcLinkBase: https://github.com/mmomtchev/node-gdal-async/blob/master/
  classes:
    paramsParameterData: green
  extraCss: scripts/gdal-doc.css
  externalCrossLinks: scripts/externalCrossLinks.js