From 4cc1ce9c62d949794f7bcae4518c802a1e76e9e2 Mon Sep 17 00:00:00 2001 From: tbrennan3 Date: Sun, 14 Feb 2010 05:53:09 +0000 Subject: [PATCH] Added @file description to bacnet.h and lib/main.cpp Fixed a build issue for the linux+MS/TP combination in trendlog.h Setup library build to define BIP_DEBUG if it is a Debug build and if it is a BIP build. --- bacnet-stack/include/bacnet.h | 16 ++++++++- bacnet-stack/include/trendlog.h | 1 + bacnet-stack/lib/Makefile | 3 ++ bacnet-stack/lib/main.cpp | 64 +++++++++++++++++---------------- 4 files changed, 52 insertions(+), 32 deletions(-) diff --git a/bacnet-stack/include/bacnet.h b/bacnet-stack/include/bacnet.h index 17f9e713..90f3cf9b 100644 --- a/bacnet-stack/include/bacnet.h +++ b/bacnet-stack/include/bacnet.h @@ -34,7 +34,7 @@ #ifndef BACNET_H #define BACNET_H -/* This file is designed to reference the entire BACnet stack library */ +/** @file bacnet.h This file is designed to reference the entire BACnet stack library */ /* core files */ #include "version.h" @@ -96,4 +96,18 @@ #include "client.h" #include "handlers.h" +/* Additions for Doxygen documenting */ +/** + * @mainpage BACnet-stack API Documentation + * This documents the BACnet-Stack API, OS ports, and sample applications.
+ * + * - The high-level handler interface can be found in the Modules tab. + * - Specifics for each file can be found in the Files tab. + * - A full list of all functions is provided in the index of the + * Files->Globals subtab. + * + * See doc/README.doxygen for notes on building and extending this document.
+ * In particular, if you have graphviz installed, you can enhance this + * documentation by turning on the function call graphs feature. + */ #endif diff --git a/bacnet-stack/include/trendlog.h b/bacnet-stack/include/trendlog.h index 60d15812..4609d5db 100644 --- a/bacnet-stack/include/trendlog.h +++ b/bacnet-stack/include/trendlog.h @@ -27,6 +27,7 @@ #include #include +#include // for time_t #include "bacdef.h" #include "cov.h" #include "rp.h" diff --git a/bacnet-stack/lib/Makefile b/bacnet-stack/lib/Makefile index 28e29400..5926461c 100644 --- a/bacnet-stack/lib/Makefile +++ b/bacnet-stack/lib/Makefile @@ -32,6 +32,9 @@ DEBUGGING = ifeq (${BUILD},debug) OPTIMIZATION = -O0 DEBUGGING = -g +ifeq (${BACDL_DEFINE},-DBACDL_BIP=1) +DEFINES += -DBIP_DEBUG +endif endif CFLAGS = -Wall $(DEBUGGING) $(OPTIMIZATION) $(STANDARDS) $(INCLUDES) $(DEFINES) diff --git a/bacnet-stack/lib/main.cpp b/bacnet-stack/lib/main.cpp index 6240b407..11ea6ebb 100644 --- a/bacnet-stack/lib/main.cpp +++ b/bacnet-stack/lib/main.cpp @@ -1,31 +1,33 @@ -#include "main.h" - -// a sample exported function -void SomeFunction(const LPCSTR sometext) -{ - MessageBoxA(0, sometext, "DLL Message", MB_OK | MB_ICONINFORMATION); -} - -BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved) -{ - switch (fdwReason) - { - case DLL_PROCESS_ATTACH: - // attach to process - // return FALSE to fail DLL load - break; - - case DLL_PROCESS_DETACH: - // detach from process - break; - - case DLL_THREAD_ATTACH: - // attach to thread - break; - - case DLL_THREAD_DETACH: - // detach from thread - break; - } - return TRUE; // succesful -} +#include "main.h" + +/** @file lib/main.cpp Provides DLLMain for Win32 build of library. */ + +// a sample exported function +void SomeFunction(const LPCSTR sometext) +{ + MessageBoxA(0, sometext, "DLL Message", MB_OK | MB_ICONINFORMATION); +} + +BOOL WINAPI DllMain(HINSTANCE hinstDLL, DWORD fdwReason, LPVOID lpvReserved) +{ + switch (fdwReason) + { + case DLL_PROCESS_ATTACH: + // attach to process + // return FALSE to fail DLL load + break; + + case DLL_PROCESS_DETACH: + // detach from process + break; + + case DLL_THREAD_ATTACH: + // attach to thread + break; + + case DLL_THREAD_DETACH: + // detach from thread + break; + } + return TRUE; // succesful +}