Updated documentation.

This commit is contained in:
skarg
2007-11-11 06:35:53 +00:00
parent 948f9afd9a
commit cae944a20c
4 changed files with 35 additions and 26 deletions
+4
View File
@@ -7,3 +7,7 @@ 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 The demos can be built using makefiles in the root directory, or by
using individual makefiles in the demo directories. 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.
+16 -10
View File
@@ -1,27 +1,33 @@
SLOC Directory SLOC-by-Language (Sorted) SLOC Directory SLOC-by-Language (Sorted)
12610 top_dir ansic=12435,sh=175 17817 ports ansic=17693,asm=124
8317 ports ansic=8317 14381 src_top_dir ansic=14381
7762 demo ansic=7762 10126 demo ansic=10126
3493 include ansic=3493
187 test ansic=187 187 test ansic=187
118 top_dir sh=118
0 bin (none)
0 doc (none) 0 doc (none)
0 lib (none)
0 license (none) 0 license (none)
0 obj (none)
0 utils (none) 0 utils (none)
Totals grouped by language (dominant language first): Totals grouped by language (dominant language first):
ansic: 28701 (99.39%) ansic: 45880 (99.48%)
sh: 175 (0.61%) asm: 124 (0.27%)
sh: 118 (0.26%)
Total Physical Source Lines of Code (SLOC) = 28,876 Total Physical Source Lines of Code (SLOC) = 46,122
Development Effort Estimate, Person-Years (Person-Months) = 6.83 (81.99) Development Effort Estimate, Person-Years (Person-Months) = 11.17 (134.06)
(Basic COCOMO model, Person-Months = 2.4 * (KSLOC**1.05)) (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)) (Basic COCOMO model, Months = 2.5 * (person-months**0.38))
Estimated Average Number of Developers (Effort/Schedule) = 6.15 Estimated Average Number of Developers (Effort/Schedule) = 8.34
Total Estimated Cost to Develop = $ 923,008 Total Estimated Cost to Develop = $ 1,509,194
(average salary = $56,286/year, overhead = 2.40). (average salary = $56,286/year, overhead = 2.40).
SLOCCount, Copyright (C) 2001-2004 David A. Wheeler SLOCCount, Copyright (C) 2001-2004 David A. Wheeler
SLOCCount is Open Source Software/Free Software, licensed under the GNU GPL. SLOCCount is Open Source Software/Free Software, licensed under the GNU GPL.
+9
View File
@@ -1,3 +1,12 @@
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 Committers need to properly configure their svn client so that
the appropriate subversion properties are set on newly added files. the appropriate subversion properties are set on newly added files.
One of the most important properties is the eol-style property One of the most important properties is the eol-style property
+4 -14
View File
@@ -17,20 +17,10 @@ M. Add function headers to each module and function with
doc-tags for some document generator like doxygen, robodoc, doc-tags for some document generator like doxygen, robodoc,
or Natural Docs. Wikipedia has a comparison of generators at: or Natural Docs. Wikipedia has a comparison of generators at:
http://en.wikipedia.org/wiki/Comparison_of_documentation_generators http://en.wikipedia.org/wiki/Comparison_of_documentation_generators
N. Convert core code into library. N. Add option to address to use file store and demos to use file store
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
instead of having to send who-is for each query. instead of having to send who-is for each query.
Use a config file for interface and interface options. This will make scripting cleaner.
These will make scripting cleaner. O. Convert object methods to use an array of object methods
P. Changed encode_tagged_xx to encode_application_xx in bacdcode.c.
Q. Convert object methods to use an array of object methods
for ReadProperty and Device object counts, ids, and names. 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. overridden in main.c.