# Doxyfile 1.9.8

DOXYFILE_ENCODING      = UTF-8

PROJECT_NAME           = "hipFile"
PROJECT_BRIEF          = "hipFile API documentation"
OUTPUT_DIRECTORY       = "."

OPTIMIZE_OUTPUT_FOR_C  = YES
EXTRACT_ALL            = NO
EXTRACT_STATIC         = YES
TYPEDEF_HIDES_STRUCT   = YES

ALIASES  = hipfile_error_return="A hipFileError_t struct that holds both hipFile and HIP error values"
ALIASES += hipfile_handle_param="Opaque file handle for GPU I/O operations"
ALIASES += buffer_base_param="Base address of the GPU buffer"
ALIASES += batch_handle_param="Opaque handle for batch operations"
ALIASES += hipstream_param="The stream used for async I/O requests"
ALIASES += hipstream_if_null="If NULL, this request will be synchronous"
ALIASES += max_io_size_note="@note The maximum I/O size is determined by the Linux kernel and is currently 2^31 - the system page size"
ALIASES += warn_not_implemented="@warning This function is only a stub on AMD and will always return an error (typically `hipFileInternalError` with `hip_drv_err` set to `hipSuccess`)"
ALIASES += warn_not_implemented_void="@warning This function is only a stub on AMD and has no effect"

INPUT                  = ../../include/hipfile.h
INPUT_ENCODING         = UTF-8
RECURSIVE              = NO

GENERATE_HTML          = YES
HTML_OUTPUT            = html
GENERATE_XML           = YES
XML_OUTPUT             = xml
GENERATE_LATEX         = NO