From cae944a20c2ee8750426aaabebf5ce336103a512 Mon Sep 17 00:00:00 2001 From: skarg Date: Sun, 11 Nov 2007 06:35:53 +0000 Subject: [PATCH] Updated documentation. --- bacnet-stack/doc/README.build | 6 +++++- bacnet-stack/doc/README.sloc | 26 ++++++++++++++++---------- bacnet-stack/doc/README.subversion | 11 ++++++++++- bacnet-stack/doc/README.todo | 18 ++++-------------- 4 files changed, 35 insertions(+), 26 deletions(-) diff --git a/bacnet-stack/doc/README.build b/bacnet-stack/doc/README.build index 43ae1b73..e3034a27 100644 --- a/bacnet-stack/doc/README.build +++ b/bacnet-stack/doc/README.build @@ -6,4 +6,8 @@ However, there are a number of example applications in the demo/ directory that show how it can be used for client and server applications. The demos can be built using makefiles in the root directory, or by -using individual makefiles in the demo directories. \ No newline at end of file +using individual makefiles in the demo directories. + +Launch the demo/server/bacserv example. Use the client demos to query +the server. Note that the server should be on a different computer or +virtual machine. diff --git a/bacnet-stack/doc/README.sloc b/bacnet-stack/doc/README.sloc index 1dee67e5..6f82db50 100644 --- a/bacnet-stack/doc/README.sloc +++ b/bacnet-stack/doc/README.sloc @@ -1,27 +1,33 @@ SLOC Directory SLOC-by-Language (Sorted) -12610 top_dir ansic=12435,sh=175 -8317 ports ansic=8317 -7762 demo ansic=7762 +17817 ports ansic=17693,asm=124 +14381 src_top_dir ansic=14381 +10126 demo ansic=10126 +3493 include ansic=3493 187 test ansic=187 +118 top_dir sh=118 +0 bin (none) 0 doc (none) +0 lib (none) 0 license (none) +0 obj (none) 0 utils (none) Totals grouped by language (dominant language first): -ansic: 28701 (99.39%) -sh: 175 (0.61%) +ansic: 45880 (99.48%) +asm: 124 (0.27%) +sh: 118 (0.26%) -Total Physical Source Lines of Code (SLOC) = 28,876 -Development Effort Estimate, Person-Years (Person-Months) = 6.83 (81.99) +Total Physical Source Lines of Code (SLOC) = 46,122 +Development Effort Estimate, Person-Years (Person-Months) = 11.17 (134.06) (Basic COCOMO model, Person-Months = 2.4 * (KSLOC**1.05)) -Schedule Estimate, Years (Months) = 1.11 (13.34) +Schedule Estimate, Years (Months) = 1.34 (16.08) (Basic COCOMO model, Months = 2.5 * (person-months**0.38)) -Estimated Average Number of Developers (Effort/Schedule) = 6.15 -Total Estimated Cost to Develop = $ 923,008 +Estimated Average Number of Developers (Effort/Schedule) = 8.34 +Total Estimated Cost to Develop = $ 1,509,194 (average salary = $56,286/year, overhead = 2.40). SLOCCount, Copyright (C) 2001-2004 David A. Wheeler SLOCCount is Open Source Software/Free Software, licensed under the GNU GPL. diff --git a/bacnet-stack/doc/README.subversion b/bacnet-stack/doc/README.subversion index 6f5ebe18..b1d12e73 100644 --- a/bacnet-stack/doc/README.subversion +++ b/bacnet-stack/doc/README.subversion @@ -1,4 +1,13 @@ -Committers need to properly configure their svn client so that +To check out the trunk from the subversion repository, +use "svn co", e.g. + + svn co https://bacnet.svn.sourceforge.net/svnroot/bacnet/trunk/bacnet-stack/ + + or for the stable releases: + + svn co https://bacnet.svn.sourceforge.net/svnroot/bacnet/tags/bacnet-stack-0-4-0/ + +Committers need to properly configure their svn client so that the appropriate subversion properties are set on newly added files. One of the most important properties is the eol-style property that configures OS-specific line-endings for text files. diff --git a/bacnet-stack/doc/README.todo b/bacnet-stack/doc/README.todo index 6606f7d4..96c3f31b 100644 --- a/bacnet-stack/doc/README.todo +++ b/bacnet-stack/doc/README.todo @@ -17,20 +17,10 @@ M. Add function headers to each module and function with doc-tags for some document generator like doxygen, robodoc, or Natural Docs. Wikipedia has a comparison of generators at: http://en.wikipedia.org/wiki/Comparison_of_documentation_generators -N. Convert core code into library. - For example, libbacnet. Includes client and server functionality - and only requires a dummy tsm_free_invoke_id function for servers. - Create bacnet.h file that includes all the necessary includes. - Split core functions into files to make library effecient. - For example, rp.c becomes rp_client.c, rp_server.c , rp_test.c; - bacint.c becomes bacint_encode.c, bacint_decode.c, bacint_test.c -O. Change address to store in a file and demos to use file +N. Add option to address to use file store and demos to use file store instead of having to send who-is for each query. - Use a config file for interface and interface options. - These will make scripting cleaner. -P. Changed encode_tagged_xx to encode_application_xx in bacdcode.c. -Q. Convert object methods to use an array of object methods + This will make scripting cleaner. +O. Convert object methods to use an array of object methods for ReadProperty and Device object counts, ids, and names. -R. Convert datalink methods to use function pointers that can be +P. Convert datalink methods to use function pointers that can be overridden in main.c. -