From 00ab20607502f3cba35179444910e4eba0cbe974 Mon Sep 17 00:00:00 2001 From: Steve Karg Date: Fri, 19 Jul 2024 17:16:28 -0500 Subject: [PATCH] * Changed header file include guards to unique namespace. Updated file headers comments with SPDX [issue #55] (#666) --- .mailmap | 2 +- apps/abort/main.c | 34 +---- apps/ack-alarm/main.c | 34 +---- apps/blinkt/device.c | 37 ++--- apps/blinkt/main.c | 34 +---- apps/dcc/main.c | 34 +---- apps/epics/bacepics.h | 41 ++--- apps/epics/main.c | 36 +---- apps/error/main.c | 34 +---- apps/event/main.c | 34 +---- apps/fuzz-afl/main.c | 31 +--- apps/fuzz-libfuzzer/main.c | 31 +--- apps/gateway/gateway.h | 44 ++---- apps/gateway/main.c | 33 +--- apps/getevent/main.c | 34 ++--- apps/iam/main.c | 34 +---- apps/iamrouter/main.c | 34 +---- apps/initrouter/main.c | 35 ++--- apps/piface/device.c | 37 ++--- apps/ptransfer/h_pt.c | 33 +--- apps/ptransfer/h_pt_a.c | 33 +--- apps/ptransfer/main.c | 33 +--- apps/ptransfer/s_ptransfer.c | 33 +--- apps/readbdt/main.c | 34 +---- apps/readfdt/main.c | 34 +---- apps/readfile/main.c | 34 +---- apps/readprop/main.c | 34 ++--- apps/readpropm/main.c | 34 ++--- apps/readrange/main.c | 35 ++--- apps/reinit/main.c | 35 ++--- apps/router-ipv6/main.c | 27 +--- apps/router-mstp/main.c | 25 +-- apps/scov/main.c | 37 ++--- apps/server/main.c | 34 +---- apps/timesync/main.c | 35 ++--- apps/ucov/main.c | 37 ++--- apps/uevent/main.c | 34 +---- apps/uptransfer/main.c | 34 ++--- apps/whohas/main.c | 36 ++--- apps/whois/main.c | 36 ++--- apps/whoisrouter/main.c | 35 ++--- apps/writebdt/main.c | 36 ++--- apps/writefile/main.c | 35 ++--- apps/writeprop/main.c | 37 ++--- apps/writepropm/main.c | 36 ++--- src/bacnet/abort.c | 43 +----- src/bacnet/abort.h | 31 +--- src/bacnet/access_rule.c | 32 +--- src/bacnet/access_rule.h | 36 ++--- src/bacnet/alarm_ack.h | 2 +- src/bacnet/apdu.h | 35 ++--- src/bacnet/arf.c | 42 +---- src/bacnet/arf.h | 35 ++--- src/bacnet/assigned_access_rights.c | 31 +--- src/bacnet/assigned_access_rights.h | 34 +---- src/bacnet/authentication_factor.c | 31 +--- src/bacnet/authentication_factor.h | 35 +---- src/bacnet/authentication_factor_format.c | 31 +--- src/bacnet/authentication_factor_format.h | 34 +---- src/bacnet/awf.c | 42 +---- src/bacnet/awf.h | 34 ++--- src/bacnet/bacaddr.c | 42 +---- src/bacnet/bacaddr.h | 34 ++--- src/bacnet/bacapp.c | 42 +---- src/bacnet/bacapp.h | 34 ++--- src/bacnet/bacdcode.c | 43 +----- src/bacnet/bacdcode.h | 34 ++--- src/bacnet/bacdef.h | 8 +- src/bacnet/bacdest.c | 6 +- src/bacnet/bacdest.h | 6 +- src/bacnet/bacdevobjpropref.c | 45 +----- src/bacnet/bacdevobjpropref.h | 36 ++--- src/bacnet/bacenum.h | 34 ++--- src/bacnet/bacerror.c | 7 + src/bacnet/bacerror.h | 34 ++--- src/bacnet/bacint.c | 44 +----- src/bacnet/bacint.h | 34 ++--- src/bacnet/bacprop.c | 43 +----- src/bacnet/bacprop.h | 35 ++--- src/bacnet/bacpropstates.c | 43 +----- src/bacnet/bacpropstates.h | 35 ++--- src/bacnet/bacreal.c | 41 +---- src/bacnet/bacreal.h | 34 ++--- src/bacnet/bacstr.c | 43 +----- src/bacnet/bacstr.h | 35 ++--- src/bacnet/bactext.c | 43 +----- src/bacnet/bactext.h | 34 ++--- src/bacnet/bactimevalue.h | 36 ++--- src/bacnet/basic/bbmd/h_bbmd.c | 43 +----- src/bacnet/basic/bbmd/h_bbmd.h | 29 +--- src/bacnet/basic/bbmd6/h_bbmd6.c | 55 ++----- src/bacnet/basic/bbmd6/h_bbmd6.h | 37 +---- src/bacnet/basic/bbmd6/vmac.c | 40 +---- src/bacnet/basic/bbmd6/vmac.h | 16 +- src/bacnet/basic/binding/address.c | 42 +---- src/bacnet/basic/binding/address.h | 34 ++--- src/bacnet/basic/client/bac-data.c | 3 +- src/bacnet/basic/client/bac-data.h | 8 +- src/bacnet/basic/client/bac-discover.c | 5 +- src/bacnet/basic/client/bac-discover.h | 15 +- src/bacnet/basic/client/bac-rw.c | 7 +- src/bacnet/basic/client/bac-rw.h | 11 +- src/bacnet/basic/client/bac-task.c | 7 +- src/bacnet/basic/client/bac-task.h | 14 +- src/bacnet/basic/npdu/h_npdu.c | 31 +--- src/bacnet/basic/npdu/h_npdu.h | 37 +---- src/bacnet/basic/npdu/h_routed_npdu.c | 40 ++--- src/bacnet/basic/npdu/h_routed_npdu.h | 37 +---- src/bacnet/basic/npdu/s_router.c | 34 +---- src/bacnet/basic/npdu/s_router.h | 27 +--- src/bacnet/basic/object/acc.c | 6 +- src/bacnet/basic/object/acc.h | 6 +- src/bacnet/basic/object/access_credential.c | 34 +---- src/bacnet/basic/object/access_credential.h | 36 ++--- src/bacnet/basic/object/access_door.c | 34 +---- src/bacnet/basic/object/access_door.h | 35 ++--- src/bacnet/basic/object/access_point.c | 34 +---- src/bacnet/basic/object/access_point.h | 35 ++--- src/bacnet/basic/object/access_rights.c | 34 +---- src/bacnet/basic/object/access_rights.h | 35 ++--- src/bacnet/basic/object/access_user.c | 34 +---- src/bacnet/basic/object/access_user.h | 35 ++--- src/bacnet/basic/object/access_zone.c | 34 +---- src/bacnet/basic/object/access_zone.h | 35 ++--- src/bacnet/basic/object/ai.c | 11 +- src/bacnet/basic/object/ai.h | 37 ++--- src/bacnet/basic/object/ao.c | 34 +---- src/bacnet/basic/object/ao.h | 39 +---- src/bacnet/basic/object/av.c | 13 +- src/bacnet/basic/object/av.h | 14 +- src/bacnet/basic/object/bacfile.c | 31 +--- src/bacnet/basic/object/bacfile.h | 45 ++---- src/bacnet/basic/object/bi.c | 9 +- src/bacnet/basic/object/bi.h | 14 +- src/bacnet/basic/object/bitstring_value.h | 144 ++++++++++++++++++ src/bacnet/basic/object/blo.c | 7 +- src/bacnet/basic/object/blo.h | 12 +- src/bacnet/basic/object/bo.c | 34 +---- src/bacnet/basic/object/bo.h | 36 +---- src/bacnet/basic/object/bv.c | 9 +- src/bacnet/basic/object/bv.h | 13 +- src/bacnet/basic/object/calendar.c | 15 +- src/bacnet/basic/object/calendar.h | 8 +- src/bacnet/basic/object/channel.c | 33 +--- src/bacnet/basic/object/channel.h | 38 +---- .../basic/object/client/device-client.c | 36 +---- src/bacnet/basic/object/color_object.c | 16 +- src/bacnet/basic/object/color_object.h | 19 +-- src/bacnet/basic/object/color_temperature.c | 16 +- src/bacnet/basic/object/color_temperature.h | 21 +-- src/bacnet/basic/object/command.c | 57 +++---- src/bacnet/basic/object/command.h | 45 +----- .../basic/object/credential_data_input.c | 34 +---- .../basic/object/credential_data_input.h | 36 ++--- src/bacnet/basic/object/csv.c | 35 +---- src/bacnet/basic/object/csv.h | 36 ++--- src/bacnet/basic/object/device.c | 6 +- src/bacnet/basic/object/device.h | 41 ++--- src/bacnet/basic/object/gateway/gw_device.c | 37 ++--- src/bacnet/basic/object/iv.c | 31 +--- src/bacnet/basic/object/iv.h | 36 +---- src/bacnet/basic/object/lc.c | 35 +---- src/bacnet/basic/object/lc.h | 36 ++--- src/bacnet/basic/object/lo.c | 28 +--- src/bacnet/basic/object/lo.h | 36 ++--- src/bacnet/basic/object/lsp.c | 34 +---- src/bacnet/basic/object/lsp.h | 36 ++--- src/bacnet/basic/object/lsz.c | 14 +- src/bacnet/basic/object/lsz.h | 23 +-- src/bacnet/basic/object/ms-input.c | 6 +- src/bacnet/basic/object/ms-input.h | 11 +- src/bacnet/basic/object/mso.c | 30 +--- src/bacnet/basic/object/mso.h | 35 +---- src/bacnet/basic/object/msv.c | 8 +- src/bacnet/basic/object/msv.h | 13 +- src/bacnet/basic/object/nc.c | 38 +---- src/bacnet/basic/object/nc.h | 35 ++--- src/bacnet/basic/object/netport.c | 32 +--- src/bacnet/basic/object/netport.h | 37 +---- src/bacnet/basic/object/objects.c | 43 +----- src/bacnet/basic/object/objects.h | 35 ++--- src/bacnet/basic/object/osv.c | 34 +---- src/bacnet/basic/object/osv.h | 36 ++--- src/bacnet/basic/object/piv.c | 34 +---- src/bacnet/basic/object/piv.h | 36 ++--- src/bacnet/basic/object/schedule.c | 32 +--- src/bacnet/basic/object/schedule.h | 37 ++--- src/bacnet/basic/object/structured_view.c | 5 +- src/bacnet/basic/object/structured_view.h | 9 +- src/bacnet/basic/object/time_value.c | 5 +- src/bacnet/basic/object/time_value.h | 8 +- src/bacnet/basic/object/trendlog.c | 32 +--- src/bacnet/basic/object/trendlog.h | 36 ++--- src/bacnet/basic/service/h_alarm_ack.c | 34 ++--- src/bacnet/basic/service/h_alarm_ack.h | 37 +---- src/bacnet/basic/service/h_apdu.c | 42 +---- src/bacnet/basic/service/h_apdu.h | 37 +---- src/bacnet/basic/service/h_arf.c | 33 +--- src/bacnet/basic/service/h_arf.h | 37 +---- src/bacnet/basic/service/h_arf_a.c | 33 +--- src/bacnet/basic/service/h_arf_a.h | 37 +---- src/bacnet/basic/service/h_awf.c | 33 +--- src/bacnet/basic/service/h_awf.h | 37 +---- src/bacnet/basic/service/h_ccov.c | 32 +--- src/bacnet/basic/service/h_ccov.h | 37 +---- src/bacnet/basic/service/h_cov.c | 33 +--- src/bacnet/basic/service/h_cov.h | 36 +---- src/bacnet/basic/service/h_create_object.c | 4 +- src/bacnet/basic/service/h_create_object.h | 9 +- src/bacnet/basic/service/h_dcc.c | 33 +--- src/bacnet/basic/service/h_dcc.h | 31 +--- src/bacnet/basic/service/h_delete_object.c | 4 +- src/bacnet/basic/service/h_delete_object.h | 9 +- src/bacnet/basic/service/h_gas_a.c | 39 +---- src/bacnet/basic/service/h_gas_a.h | 31 +--- src/bacnet/basic/service/h_get_alarm_sum.c | 33 +--- src/bacnet/basic/service/h_get_alarm_sum.h | 37 +---- src/bacnet/basic/service/h_getevent.c | 33 +--- src/bacnet/basic/service/h_getevent.h | 36 +---- src/bacnet/basic/service/h_getevent_a.c | 41 +---- src/bacnet/basic/service/h_getevent_a.h | 36 +---- src/bacnet/basic/service/h_iam.c | 33 +--- src/bacnet/basic/service/h_iam.h | 37 +---- src/bacnet/basic/service/h_ihave.c | 33 +--- src/bacnet/basic/service/h_ihave.h | 37 +---- src/bacnet/basic/service/h_list_element.c | 6 +- src/bacnet/basic/service/h_list_element.h | 11 +- src/bacnet/basic/service/h_lso.c | 33 +--- src/bacnet/basic/service/h_lso.h | 37 +---- src/bacnet/basic/service/h_noserv.c | 33 +--- src/bacnet/basic/service/h_noserv.h | 37 +---- src/bacnet/basic/service/h_rd.c | 33 +--- src/bacnet/basic/service/h_rd.h | 37 +---- src/bacnet/basic/service/h_rp_a.c | 33 +--- src/bacnet/basic/service/h_rp_a.h | 37 +---- src/bacnet/basic/services.h | 31 +--- src/bacnet/basic/sys/bigend.c | 14 +- src/bacnet/basic/sys/bigend.h | 35 ++--- src/bacnet/basic/sys/bits.h | 8 +- src/bacnet/basic/sys/bytes.h | 8 +- src/bacnet/basic/sys/color_rgb.c | 11 +- src/bacnet/basic/sys/color_rgb.h | 7 +- src/bacnet/basic/sys/days.c | 11 +- src/bacnet/basic/sys/days.h | 3 +- src/bacnet/basic/sys/debug.c | 42 +---- src/bacnet/basic/sys/debug.h | 35 ++--- src/bacnet/basic/sys/fifo.c | 37 +---- src/bacnet/basic/sys/fifo.h | 13 +- src/bacnet/basic/sys/filename.c | 42 +---- src/bacnet/basic/sys/filename.h | 35 ++--- src/bacnet/basic/sys/key.h | 39 ++--- src/bacnet/basic/sys/keylist.c | 53 ++----- src/bacnet/basic/sys/keylist.h | 35 ++--- src/bacnet/basic/sys/linear.c | 41 +---- src/bacnet/basic/sys/linear.h | 8 +- src/bacnet/basic/sys/mstimer.c | 12 +- src/bacnet/basic/sys/mstimer.h | 22 +-- src/bacnet/basic/sys/platform.h | 12 +- src/bacnet/basic/sys/ringbuf.c | 53 +------ src/bacnet/basic/sys/ringbuf.h | 13 +- src/bacnet/basic/sys/sbuf.c | 48 +----- src/bacnet/basic/sys/sbuf.h | 38 ++--- src/bacnet/calendar_entry.c | 6 +- src/bacnet/calendar_entry.h | 4 +- src/bacnet/config.h | 6 +- src/bacnet/cov.c | 42 +---- src/bacnet/cov.h | 34 ++--- src/bacnet/create_object.c | 4 +- src/bacnet/create_object.h | 4 +- src/bacnet/credential_authentication_factor.c | 32 +--- src/bacnet/credential_authentication_factor.h | 33 +--- src/bacnet/dailyschedule.h | 35 ++--- src/bacnet/datalink/arcnet.h | 36 ++--- src/bacnet/datalink/automac.c | 7 +- src/bacnet/datalink/automac.h | 38 ++--- src/bacnet/datalink/bacsec.c | 31 +--- src/bacnet/datalink/bacsec.h | 31 +--- src/bacnet/datalink/bip.h | 35 ++--- src/bacnet/datalink/bip6.h | 15 +- src/bacnet/datalink/bvlc.c | 43 ++---- src/bacnet/datalink/bvlc.h | 36 ++--- src/bacnet/datalink/bvlc6.c | 43 ++---- src/bacnet/datalink/bvlc6.h | 20 +-- src/bacnet/datalink/cobs.c | 32 ++-- src/bacnet/datalink/cobs.h | 36 ++--- src/bacnet/datalink/crc.c | 45 ++---- src/bacnet/datalink/crc.h | 36 ++--- src/bacnet/datalink/datalink.c | 43 ++---- src/bacnet/datalink/datalink.h | 35 ++--- src/bacnet/datalink/dlenv.c | 34 +---- src/bacnet/datalink/dlenv.h | 36 ++--- src/bacnet/datalink/dlmstp.c | 8 +- src/bacnet/datalink/dlmstp.h | 36 ++--- src/bacnet/datalink/ethernet.h | 36 ++--- src/bacnet/datalink/mstp.c | 69 +++------ src/bacnet/datalink/mstp.h | 37 ++--- src/bacnet/datalink/mstpdef.h | 36 ++--- src/bacnet/datalink/mstptext.c | 42 ++--- src/bacnet/datalink/mstptext.h | 37 ++--- src/bacnet/datetime.c | 4 +- src/bacnet/datetime.h | 4 +- src/bacnet/dcc.c | 42 +---- src/bacnet/dcc.h | 34 ++--- src/bacnet/delete_object.c | 4 +- src/bacnet/delete_object.h | 4 +- src/bacnet/event.c | 41 +---- src/bacnet/event.h | 31 +--- src/bacnet/get_alarm_sum.c | 25 +-- src/bacnet/get_alarm_sum.h | 37 ++--- src/bacnet/getevent.c | 42 +---- src/bacnet/getevent.h | 34 ++--- src/bacnet/hostnport.c | 6 +- src/bacnet/hostnport.h | 6 +- src/bacnet/iam.c | 42 +---- src/bacnet/iam.h | 34 ++--- src/bacnet/ihave.c | 42 +---- src/bacnet/ihave.h | 34 ++--- src/bacnet/indtext.c | 40 +---- src/bacnet/indtext.h | 34 ++--- src/bacnet/lighting.c | 6 +- src/bacnet/lighting.h | 11 +- src/bacnet/list_element.c | 6 +- src/bacnet/list_element.h | 6 +- src/bacnet/lso.c | 43 +----- src/bacnet/lso.h | 35 ++--- src/bacnet/memcopy.c | 35 +---- src/bacnet/memcopy.h | 37 ++--- src/bacnet/npdu.c | 40 +---- src/bacnet/npdu.h | 34 ++--- src/bacnet/property.c | 6 +- src/bacnet/property.h | 10 +- src/bacnet/proplist.c | 40 +---- src/bacnet/proplist.h | 35 ++--- src/bacnet/ptransfer.c | 42 +---- src/bacnet/ptransfer.h | 34 ++--- src/bacnet/rd.c | 41 +---- src/bacnet/rd.h | 34 ++--- src/bacnet/readrange.c | 43 +----- src/bacnet/readrange.h | 39 ++--- src/bacnet/reject.c | 42 +---- src/bacnet/reject.h | 30 +--- src/bacnet/rp.c | 43 +----- src/bacnet/rp.h | 34 ++--- src/bacnet/special_event.c | 1 - src/bacnet/special_event.h | 4 +- src/bacnet/timestamp.h | 35 ++--- src/bacnet/timesync.c | 42 +---- src/bacnet/timesync.h | 35 ++--- src/bacnet/version.h | 8 +- src/bacnet/whois.c | 42 +---- src/bacnet/whois.h | 34 ++--- src/bacnet/wp.c | 40 +---- src/bacnet/wp.h | 34 ++--- src/bacnet/wpm.c | 34 ++--- src/bacnet/wpm.h | 36 ++--- 355 files changed, 2597 insertions(+), 8082 deletions(-) diff --git a/.mailmap b/.mailmap index d94755b1..1b488ed7 100644 --- a/.mailmap +++ b/.mailmap @@ -5,7 +5,7 @@ root Steve Karg Tom Brennan John Minack -Peter McShane +Peter Mc Shane Edward Hague Edward Hague Tom Pacheco diff --git a/apps/abort/main.c b/apps/abort/main.c index 8694b05d..fa0867dc 100644 --- a/apps/abort/main.c +++ b/apps/abort/main.c @@ -1,29 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2016 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service */ +/** + * @file + * @brief command line tool that sends a BACnet service Abort message + * to the network + * @author Steve Karg + * @date 2016 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/ack-alarm/main.c b/apps/ack-alarm/main.c index 586205a2..49e23615 100644 --- a/apps/ack-alarm/main.c +++ b/apps/ack-alarm/main.c @@ -1,29 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2021 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service */ +/** + * @file + * @brief command line tool that sends a BACnet service to the network: + * Ack-Alarm message + * @author Steve Karg + * @date 2021 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/blinkt/device.c b/apps/blinkt/device.c index 61ac0cb8..e38e6e9a 100644 --- a/apps/blinkt/device.c +++ b/apps/blinkt/device.c @@ -1,31 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2005,2006,2009 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/** @file device.c Base "class" for handling all BACnet objects belonging - * to a BACnet device, as well as Device-specific properties. */ - +/** + * @file + * @brief Base "class" for handling all BACnet objects belonging + * to a BACnet device, as well as Device-specific properties. + * @author Steve Karg + * @date 2005,2006,2009 + * @date 2021 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/blinkt/main.c b/apps/blinkt/main.c index 7a743403..b4ef416f 100644 --- a/apps/blinkt/main.c +++ b/apps/blinkt/main.c @@ -1,27 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief Example application using the BACnet Stack on a Raspberry Pi + * with Blinkt! LEDs. + * @author Steve Karg + * @date 2023 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -61,8 +45,6 @@ #include "bacport.h" #include "blinkt.h" -/** @file blinkt/main.c Example application using the BACnet Stack. */ - /* (Doxygen note: The next two lines pull all the following Javadoc * into the ServerDemo module.) */ /** @addtogroup ServerDemo */ diff --git a/apps/dcc/main.c b/apps/dcc/main.c index aed455bf..a023f04c 100644 --- a/apps/dcc/main.c +++ b/apps/dcc/main.c @@ -1,29 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool demo for BACnet stack */ +/** + * @file + * @brief command line tool that sends a BACnet service to the network: + * DeviceCommunicationControl message + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/epics/bacepics.h b/apps/epics/bacepics.h index ea9a5990..179086f6 100644 --- a/apps/epics/bacepics.h +++ b/apps/epics/bacepics.h @@ -1,33 +1,14 @@ -/************************************************************************** -* -* Copyright (C) 2006 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ - -#ifndef BACEPICS_H_ -#define BACEPICS_H_ - -/** @file epics/bacepics.h Header for tool to generate EPICS-usable output. */ - +/** + * @file + * @brief command line tool to generate EPICS-usable output acquired from + * a BACnet device on the network. + * @author Steve Karg + * @author Tom Brennan + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BACEPICS_H_ +#define BACNET_BACEPICS_H_ /** @defgroup BACEPICS Tool to generate EPICS-usable output. * @ingroup Demos diff --git a/apps/epics/main.c b/apps/epics/main.c index 2b504b2d..6060f0d0 100644 --- a/apps/epics/main.c +++ b/apps/epics/main.c @@ -1,31 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/** @file epics/main.c Command line tool to build a full VTS3 EPICS file, - * including the heading information. */ - +/** + * @file + * @brief command line tool to generate EPICS-usable output acquired from + * a BACnet device on the network. + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/error/main.c b/apps/error/main.c index 537b9942..41a83206 100644 --- a/apps/error/main.c +++ b/apps/error/main.c @@ -1,29 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2016 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service */ +/** + * @file + * @brief command line tool that sends a BACnet service to the network: + * BACnet Error message + * @author Steve Karg + * @date 2016 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/event/main.c b/apps/event/main.c index e8f44107..d1fc765e 100644 --- a/apps/event/main.c +++ b/apps/event/main.c @@ -1,29 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2021 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service */ +/** + * @file + * @brief command line tool that sends a BACnet service to the network: + * BACnet EventNotification message + * @author Steve Karg + * @date 2021 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/fuzz-afl/main.c b/apps/fuzz-afl/main.c index 2adddbce..b8278118 100644 --- a/apps/fuzz-afl/main.c +++ b/apps/fuzz-afl/main.c @@ -1,32 +1,9 @@ /** * @file - * @author Steve Karg, Anthony Delorenzo - * @date 2020 - * @brief - * - * @section LICENSE - * - * Copyright (C) 2020 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * + * @brief command line fuzz (data scrambling) interface for security testing + * @author Anthony Delorenzo + * @date 2023 + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/apps/fuzz-libfuzzer/main.c b/apps/fuzz-libfuzzer/main.c index c2530ec5..90e4a362 100644 --- a/apps/fuzz-libfuzzer/main.c +++ b/apps/fuzz-libfuzzer/main.c @@ -1,32 +1,9 @@ /** * @file - * @author Steve Karg, Anthony Delorenzo - * @date 2020 - * @brief - * - * @section LICENSE - * - * Copyright (C) 2020 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * + * @brief command line fuzz (data scrambling) interface for security testing + * @author Anthony Delorenzo + * @date 2023 + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/apps/gateway/gateway.h b/apps/gateway/gateway.h index 5361c878..2f5511f5 100644 --- a/apps/gateway/gateway.h +++ b/apps/gateway/gateway.h @@ -1,33 +1,13 @@ -/************************************************************************** -* -* Copyright (C) 2006 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ - -#ifndef GATEWAY_H_ -#define GATEWAY_H_ - -/** @file gateway/gateway.h Header for example gateway (ie, BACnet Router - * and Devices) using the BACnet Stack. */ +/** + * @file + * @brief Header for example gateway (ie, BACnet Router and Devices) + * using the BACnet Stack. + * @author Tom Brennan + * @date 2010 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_GATEWAY_H_ +#define BACNET_GATEWAY_H_ /** @defgroup GatewayDemo Demo of a BACnet virtual gateway (multiple Device). * @ingroup Demos @@ -43,6 +23,4 @@ #define DEV_DESCR_GATEWAY "Gateway Device and Router" #define DEV_DESCR_REMOTE "Routed Remote Device" - - -#endif /* GATEWAY_H_ */ +#endif diff --git a/apps/gateway/main.c b/apps/gateway/main.c index 53188e98..c682541b 100644 --- a/apps/gateway/main.c +++ b/apps/gateway/main.c @@ -1,32 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ /** + * @file + * @brief Example virtual gateway application using the BACnet Stack. * Code for this project began with code from the demo/server project and * Paul Chapman's vmac project. + * @author Tom Brennan + * @date 2010 + * @copyright SPDX-License-Identifier: MIT */ - #include #include #include @@ -60,9 +40,6 @@ /* me! */ #include "gateway.h" -/** @file gateway/main.c Example virtual gateway application using the BACnet - * Stack. */ - /* Prototypes */ /* (Doxygen note: The next two lines pull all the following Javadoc diff --git a/apps/getevent/main.c b/apps/getevent/main.c index 48efa8c7..4b2d7768 100644 --- a/apps/getevent/main.c +++ b/apps/getevent/main.c @@ -1,28 +1,12 @@ -/************************************************************************* - * Copyright (C) 2015 B Weitsch - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service, and displays the reply */ +/** + * @file + * @brief command line tool that sends a BACnet service to the network - + * GetEventInformation message - and displays the reply. + * @author Steve Karg + * @author Boris Weitsch + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/iam/main.c b/apps/iam/main.c index a0006ef5..6259c409 100644 --- a/apps/iam/main.c +++ b/apps/iam/main.c @@ -1,29 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2016 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service */ +/** + * @file + * @brief command line tool that sends a BACnet service to the network: + * I-Am message + * @author Steve Karg + * @date 2016 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/iamrouter/main.c b/apps/iamrouter/main.c index 553081cf..74e6fb9f 100644 --- a/apps/iamrouter/main.c +++ b/apps/iamrouter/main.c @@ -1,29 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2008 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service, and displays the reply */ +/** + * @file + * @brief command line tool that sends a BACnet I-Am-Router-To-Network message + * for one or more networks. + * @author Steve Karg + * @date 2008 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/initrouter/main.c b/apps/initrouter/main.c index aa73f1b4..427df321 100644 --- a/apps/initrouter/main.c +++ b/apps/initrouter/main.c @@ -1,29 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2008 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service, and displays the reply */ +/** + * @file + * @brief command line tool that sends a BACnet Initialize-Routing-Table + * message to a network and waits for responses. Displays their network + * information from the response. This is a router-to-router message. + * @author Steve Karg + * @date 2008 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/piface/device.c b/apps/piface/device.c index 5841326d..c53fcad1 100644 --- a/apps/piface/device.c +++ b/apps/piface/device.c @@ -1,31 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2005,2006,2009 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/** @file device.c Base "class" for handling all BACnet objects belonging - * to a BACnet device, as well as Device-specific properties. */ - +/** + * @file + * @brief Base "class" for handling all BACnet objects belonging + * to a BACnet device, as well as Device-specific properties. + * @author Steve Karg + * @date 2005,2006,2009 + * @date 2021 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/ptransfer/h_pt.c b/apps/ptransfer/h_pt.c index 495208d5..fe5ae891 100644 --- a/apps/ptransfer/h_pt.c +++ b/apps/ptransfer/h_pt.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2005 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief Handler for a BACnet ConfirmedPrivateTransfer-Request example + * @author Peter Mc Shane + * @date 2005 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -38,8 +21,6 @@ #include "bacnet/basic/services.h" #include "bacnet/basic/tsm/tsm.h" -/** @file h_pt.c Handles Confirmed Private Transfer requests. */ - #define MYMAXSTR 32 #define MYMAXBLOCK 8 diff --git a/apps/ptransfer/h_pt_a.c b/apps/ptransfer/h_pt_a.c index 5b8565b4..9e2f5cb5 100644 --- a/apps/ptransfer/h_pt_a.c +++ b/apps/ptransfer/h_pt_a.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2005 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief Handler for a BACnet ConfirmedPrivateTransfer Acknowledgment example + * @author Peter Mc Shane + * @date 2005 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -38,8 +21,6 @@ #include "bacnet/basic/services.h" #include "bacnet/basic/tsm/tsm.h" -/** @file h_pt_a.c Handles Confirmed Private Transfer Acknowledgment. */ - extern uint8_t IOBufferPT[300]; /* Somewhere to build the encoded result block for Private Transfers */ diff --git a/apps/ptransfer/main.c b/apps/ptransfer/main.c index e3a498dc..c1ae476c 100644 --- a/apps/ptransfer/main.c +++ b/apps/ptransfer/main.c @@ -1,28 +1,11 @@ -/************************************************************************* - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service, and displays the reply */ +/** + * @file + * @brief command line application for a BACnet ConfirmedPrivateTransfer + * service. This application is a test program for the BACnet stack. + * @author Peter Mc Shane + * @date 2005 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/ptransfer/s_ptransfer.c b/apps/ptransfer/s_ptransfer.c index a4017730..494bad81 100644 --- a/apps/ptransfer/s_ptransfer.c +++ b/apps/ptransfer/s_ptransfer.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief Sends a BACnet service to the network: PrivateTransfer-Request + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -42,8 +25,6 @@ #include "bacnet/datalink/datalink.h" #include "bacnet/basic/services.h" -/** @file s_ptransfer.c Send a Private Transfer request. */ - uint8_t Send_Private_Transfer_Request(uint32_t device_id, uint16_t vendor_id, uint32_t service_number, diff --git a/apps/readbdt/main.c b/apps/readbdt/main.c index 186eba76..5cb6e1e6 100644 --- a/apps/readbdt/main.c +++ b/apps/readbdt/main.c @@ -1,29 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2012 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet BVLC message, and displays the reply */ +/** + * @file + * @brief command line tool that sends a BACnet BVLC message, and displays + * the reply, for a Read-Broadcast-Distribution-Table message to a peer BBMD. + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/readfdt/main.c b/apps/readfdt/main.c index 840558ee..81cf99a8 100644 --- a/apps/readfdt/main.c +++ b/apps/readfdt/main.c @@ -1,29 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2012 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet BVLC message, and displays the reply */ +/** + * @file + * @brief command line tool that sends a BACnet BVLC message, and displays + * the reply, for a Read-Foreign-Device-Table message to a peer BBMD. + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/readfile/main.c b/apps/readfile/main.c index e5422859..038eb72a 100644 --- a/apps/readfile/main.c +++ b/apps/readfile/main.c @@ -1,29 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service, and displays the reply */ +/** + * @file + * @brief command line tool that uses BACnet AtomicReadFile service messages + * to read a file object contents from another device, and save it locally. + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/readprop/main.c b/apps/readprop/main.c index 4378ccf4..d4ce6bfa 100644 --- a/apps/readprop/main.c +++ b/apps/readprop/main.c @@ -1,28 +1,12 @@ -/************************************************************************* - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service, and displays the reply */ +/** + * @file + * @brief command line tool that uses BACnet ReadProperty service message + * to read object property value from another device on the network + * and prints the value to the console. + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/readpropm/main.c b/apps/readpropm/main.c index 5c8046ff..6d8c1f14 100644 --- a/apps/readpropm/main.c +++ b/apps/readpropm/main.c @@ -1,28 +1,12 @@ -/************************************************************************* - * Copyright (C) 2008 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service, and displays the reply */ +/** + * @file + * @brief command line tool that uses BACnet ReadPropertyMultiple service + * message to read object property values from another device on + * the network and prints the values to the console. + * @author Steve Karg + * @date 2008 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/readrange/main.c b/apps/readrange/main.c index cfbe3bee..9f9991a1 100644 --- a/apps/readrange/main.c +++ b/apps/readrange/main.c @@ -1,30 +1,13 @@ -/************************************************************************* - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - +/** + * @file + * @brief command line tool that uses BACnet ReadRange service + * message to read device object BACnetList or BACnetARRAY property values + * from another device on the network and prints the values to the console. + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #define PRINT_ENABLED 1 - -/* command line tool that sends a BACnet service, and displays the reply */ #include #include #include diff --git a/apps/reinit/main.c b/apps/reinit/main.c index a9395b36..ca2517eb 100644 --- a/apps/reinit/main.c +++ b/apps/reinit/main.c @@ -1,29 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service, and displays the reply */ +/** + * @file + * @brief command line tool that uses BACnet ReinitializeDevice service + * message to reinitialize another device on the network and prints an + * acknowledgment or error response of this confirmed service request. + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/router-ipv6/main.c b/apps/router-ipv6/main.c index 1f53e4fa..fd282c9f 100644 --- a/apps/router-ipv6/main.c +++ b/apps/router-ipv6/main.c @@ -1,32 +1,9 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2016 * @brief Simple BACnet/IP to BACnet/IPv6 router - * - * @section LICENSE - * - * Copyright (C) 2016 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/apps/router-mstp/main.c b/apps/router-mstp/main.c index 63eb1202..15725ee2 100644 --- a/apps/router-mstp/main.c +++ b/apps/router-mstp/main.c @@ -3,30 +3,7 @@ * @author Steve Karg * @date 2020 * @brief Simple BACnet/IP to MS/TP router - * - * @section LICENSE - * - * Copyright (C) 2020 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/apps/scov/main.c b/apps/scov/main.c index 7b0fd188..130844cd 100644 --- a/apps/scov/main.c +++ b/apps/scov/main.c @@ -1,28 +1,13 @@ -/************************************************************************* - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service, and displays the reply */ +/** + * @file + * @brief command line tool that uses BACnet SubscribeCOV service + * message to subscribe to a BACnet object for Change-of-Value notifications + * in a BACnet device and print the Change-of-Value notifications values + * to the console. + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -185,6 +170,8 @@ static void print_usage(char *filename) static void print_help(char *filename) { + printf("Subscribe to a BACnet object for Change-of-Value notifications\n" + "in a BACnet device and print the Change-of-Value notifications.\n"); printf("\n"); printf("device-id:\n" "The subscriber BACnet Device Object Instance number.\n"); diff --git a/apps/server/main.c b/apps/server/main.c index f76c43ef..5d8a5200 100644 --- a/apps/server/main.c +++ b/apps/server/main.c @@ -1,27 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief command line tool that simulates a BACnet server device on the + * network using the BACnet Stack and all the example object types. + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -71,8 +55,6 @@ #include "bacnet/basic/ucix/ucix.h" #endif /* defined(BAC_UCI) */ -/** @file server/main.c Example server application using the BACnet Stack. */ - /* (Doxygen note: The next two lines pull all the following Javadoc * into the ServerDemo module.) */ /** @addtogroup ServerDemo */ diff --git a/apps/timesync/main.c b/apps/timesync/main.c index 6ab4b1f4..1cc2eaeb 100644 --- a/apps/timesync/main.c +++ b/apps/timesync/main.c @@ -1,29 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service, and displays the reply */ +/** + * @file + * @brief command line tool that sends a BACnet TimeSynchronization service + * message with the local or arbitrary time and date to sync another device + * on the network. + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/ucov/main.c b/apps/ucov/main.c index c2d1391c..26d448e0 100644 --- a/apps/ucov/main.c +++ b/apps/ucov/main.c @@ -1,29 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service */ +/** + * @file + * @brief command line tool that sends a BACnet Unconfirmed Change-of-Value + * Notification to the network + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -67,6 +49,9 @@ static void Init_Service_Handlers(void) static void print_usage(char *filename) { + printf("Sends a BACnet Unconfirmed Change-of-Value Notification\n" + "to the network.\n"); + printf("\n"); printf("Usage: %s pid device-id object-type object-instance " "time property tag value [priority] [index]\n", filename); printf("\n"); diff --git a/apps/uevent/main.c b/apps/uevent/main.c index 841191b4..e2fd01ae 100644 --- a/apps/uevent/main.c +++ b/apps/uevent/main.c @@ -1,29 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2016 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service */ +/** + * @file + * @brief command line tool that sends a BACnet UnconfirmedEventNotification + * to the network + * @author Steve Karg + * @date 2016 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/uptransfer/main.c b/apps/uptransfer/main.c index 2057e7f4..1de2e629 100644 --- a/apps/uptransfer/main.c +++ b/apps/uptransfer/main.c @@ -1,28 +1,11 @@ -/************************************************************************* - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service, and displays the reply */ +/** + * @file + * @brief command line tool that sends a BACnet UnconfirmedPrivateTransfer + * message to the network + * @author Steve Karg + * @date 2016 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -143,6 +126,7 @@ static void print_usage(char *filename) static void print_help(char *filename) { + printf("Send BACnet UnconfirmedPrivateTransfer message to the network.\n"); printf("device-instance:\n" "BACnet Device Object Instance number that you are\n" "trying to communicate to. This number will be used\n" diff --git a/apps/whohas/main.c b/apps/whohas/main.c index 40b8664d..1e8449a1 100644 --- a/apps/whohas/main.c +++ b/apps/whohas/main.c @@ -1,29 +1,13 @@ -/************************************************************************** - * - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service, and displays the reply */ +/** + * @file + * @brief command line tool that sends a BACnet Who-Has request to devices, + * and prints any I-Have responses received. This is useful for finding + * devices on the network, or for finding devices that support a particular + * object type and instance range. + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/whois/main.c b/apps/whois/main.c index 368c8bd4..18c60421 100644 --- a/apps/whois/main.c +++ b/apps/whois/main.c @@ -1,29 +1,13 @@ -/************************************************************************** - * - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service, and displays the reply */ +/** + * @file + * @brief command line tool that sends a BACnet Who-Is request to devices, + * and prints any I-Am responses received. This is useful for finding + * devices on a network, or for finding devices that are in a specific + * instance range. + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/whoisrouter/main.c b/apps/whoisrouter/main.c index 6f5f11a7..f993cd1e 100644 --- a/apps/whoisrouter/main.c +++ b/apps/whoisrouter/main.c @@ -1,29 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2008 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service, and displays the reply */ +/** + * @file + * @brief command line tool that sends a BACnet Who-Is-Router-To-Network + * message for one or more networks, and prints any I-Am-Router-To-Network + * responses received. This is useful for finding routers on the network. + * @author Steve Karg + * @date 2008 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/writebdt/main.c b/apps/writebdt/main.c index 781aeb90..1175db10 100644 --- a/apps/writebdt/main.c +++ b/apps/writebdt/main.c @@ -1,29 +1,13 @@ -/************************************************************************** - * - * Copyright (C) 2020 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet BVLC message, and displays the reply */ +/** + * @file + * @brief command line tool that sends a BACnet BVLC message + * Write-Broadcast-Distribution-Table to a BBMD on the network, + * and prints the result code received. This is useful for + * configuring the BBMD on the network. + * @author Steve Karg + * @date 2020 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/writefile/main.c b/apps/writefile/main.c index 58f6f49d..bb281cb6 100644 --- a/apps/writefile/main.c +++ b/apps/writefile/main.c @@ -1,29 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service, and displays the reply */ +/** + * @file + * @brief command line tool that uses BACnet AtomicWriteFile service + * to send a local file to a another device on the network. + * This tool sends the file in chunks to the target device. + * @author Steve Karg + * @date 2008 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/writeprop/main.c b/apps/writeprop/main.c index 9e35dccf..26bdf40a 100644 --- a/apps/writeprop/main.c +++ b/apps/writeprop/main.c @@ -1,29 +1,14 @@ -/************************************************************************** - * - * Copyright (C) 2006-2007 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service, and displays the response */ +/** + * @file + * @brief command line tool that uses BACnet WriteProperty service + * message to write object property values to another device on + * the network and prints an acknowledgment or error response of + * this confirmed service request. This is useful for testing + * the WriteProperty service. + * @author Steve Karg + * @date 2006-2007 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/apps/writepropm/main.c b/apps/writepropm/main.c index 8c904698..c17441cf 100644 --- a/apps/writepropm/main.c +++ b/apps/writepropm/main.c @@ -1,28 +1,14 @@ -/************************************************************************* - * Copyright (C) 2017 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* command line tool that sends a BACnet service, and displays the reply */ +/** + * @file + * @brief command line tool that uses BACnet WritePropertyMultiple service + * message to write object property values to another device on + * the network and prints an acknowledgment or error response of + * this confirmed service request. This is useful for testing + * the WritePropertyMultiple service. + * @author Steve Karg + * @date 2017 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/abort.c b/src/bacnet/abort.c index d393f4ac..f17e4365 100644 --- a/src/bacnet/abort.c +++ b/src/bacnet/abort.c @@ -1,36 +1,11 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2005 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet Abort Reason Encoding and Decoding + * @author Steve Karg + * @author Peter McShane + * @date 2007 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" @@ -38,8 +13,6 @@ #include "bacnet/bacdcode.h" #include "bacnet/abort.h" -/** @file abort.c Abort Encoding/Decoding */ - /** * @brief Convert error-code into abort-reason * diff --git a/src/bacnet/abort.h b/src/bacnet/abort.h index 5af317e8..a4387ca8 100644 --- a/src/bacnet/abort.h +++ b/src/bacnet/abort.h @@ -1,26 +1,11 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ +/** + * @file + * @brief BACnet Abort Reason Encoding and Decoding + * @author Steve Karg + * @author Peter McShane + * @date 2007 + * @copyright SPDX-License-Identifier: MIT + */ #ifndef BACNET_ABORT_H #define BACNET_ABORT_H diff --git a/src/bacnet/access_rule.c b/src/bacnet/access_rule.c index d7ce63c9..bb11dcc3 100644 --- a/src/bacnet/access_rule.c +++ b/src/bacnet/access_rule.c @@ -1,28 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2015 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - +/** + * @file + * @brief BACnetAccessRule service encode and decode + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include "bacnet/access_rule.h" diff --git a/src/bacnet/access_rule.h b/src/bacnet/access_rule.h index 9fc3030c..8fb5b8c5 100644 --- a/src/bacnet/access_rule.h +++ b/src/bacnet/access_rule.h @@ -1,30 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2015 Nikola Jelic -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ - -#ifndef ACCESS_RULE_H -#define ACCESS_RULE_H +/** + * @file + * @brief BACnetAccessRule service encode and decode + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_ACCESS_RULE_H +#define BACNET_ACCESS_RULE_H #include #include diff --git a/src/bacnet/alarm_ack.h b/src/bacnet/alarm_ack.h index cb9b022d..0437f2bc 100644 --- a/src/bacnet/alarm_ack.h +++ b/src/bacnet/alarm_ack.h @@ -17,7 +17,7 @@ #include "bacnet/bacapp.h" #include "bacnet/timestamp.h" -typedef struct { +typedef struct BACnetAcknowledgeAlarmInfo { uint32_t ackProcessIdentifier; BACNET_OBJECT_ID eventObjectIdentifier; BACNET_EVENT_STATE eventStateAcked; diff --git a/src/bacnet/apdu.h b/src/bacnet/apdu.h index fa74e68c..057470cf 100644 --- a/src/bacnet/apdu.h +++ b/src/bacnet/apdu.h @@ -1,29 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef APDU_H -#define APDU_H - +/** + * @file + * @brief BACnet APDU structures + * @author Steve Karg + * @date 2007 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_APDU_H +#define BACNET_APDU_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/arf.c b/src/bacnet/arf.c index 5134bc7c..84f4e1dd 100644 --- a/src/bacnet/arf.c +++ b/src/bacnet/arf.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2005 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet AtomicReadFile service structures, codecs, and handlers. + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" @@ -38,8 +12,6 @@ #include "bacnet/bacdcode.h" #include "bacnet/arf.h" -/** @file arf.c Atomic Read File */ - /** * @brief Encode the AtomicReadFile service request * diff --git a/src/bacnet/arf.h b/src/bacnet/arf.h index 73c9ffb7..7b886ccb 100644 --- a/src/bacnet/arf.h +++ b/src/bacnet/arf.h @@ -1,29 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef ATOMIC_READ_FILE_H -#define ATOMIC_READ_FILE_H - +/** + * @file + * @brief BACnet AtomicReadFile service structures, codecs, and handlers. + * @author Steve Karg + * @date 2007 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_ATOMIC_READ_FILE_H +#define BACNET_ATOMIC_READ_FILE_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/assigned_access_rights.c b/src/bacnet/assigned_access_rights.c index a86e1c41..40248f3f 100644 --- a/src/bacnet/assigned_access_rights.c +++ b/src/bacnet/assigned_access_rights.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2015 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief BACnetAssignedAccessRights structure and codecs + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #include #include "bacnet/assigned_access_rights.h" #include "bacnet/bacdcode.h" diff --git a/src/bacnet/assigned_access_rights.h b/src/bacnet/assigned_access_rights.h index 8e00ca4b..18d7b800 100644 --- a/src/bacnet/assigned_access_rights.h +++ b/src/bacnet/assigned_access_rights.h @@ -1,28 +1,10 @@ -/************************************************************************** -* -* Copyright (C) 2015 Nikola Jelic -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ - +/** + * @file + * @brief BACnetAssignedAccessRights structure and codecs + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #ifndef BACNET_ASSIGNED_ACCESS_RIGHTS_H #define BACNET_ASSIGNED_ACCESS_RIGHTS_H @@ -34,7 +16,7 @@ #include "bacnet/bacapp.h" #include "bacnet/bacdevobjpropref.h" -typedef struct { +typedef struct BACnetAssignedAccessRights { BACNET_DEVICE_OBJECT_REFERENCE assigned_access_rights; bool enable; } BACNET_ASSIGNED_ACCESS_RIGHTS; diff --git a/src/bacnet/authentication_factor.c b/src/bacnet/authentication_factor.c index 9d4742c8..d9d295b8 100644 --- a/src/bacnet/authentication_factor.c +++ b/src/bacnet/authentication_factor.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2015 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief BACnet BACnetAuthenticationFactor structure and codecs + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #include #include "bacnet/authentication_factor.h" #include "bacnet/bacdcode.h" diff --git a/src/bacnet/authentication_factor.h b/src/bacnet/authentication_factor.h index aac73195..267f97f1 100644 --- a/src/bacnet/authentication_factor.h +++ b/src/bacnet/authentication_factor.h @@ -1,28 +1,10 @@ -/************************************************************************** -* -* Copyright (C) 2015 Nikola Jelic -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ - +/** + * @file + * @brief BACnet BACnetAuthenticationFactor structure and codecs + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #ifndef BACNET_AUTHENTICATION_FACTOR_H #define BACNET_AUTHENTICATION_FACTOR_H @@ -33,13 +15,12 @@ /* BACnet Stack API */ #include "bacnet/bacapp.h" -typedef struct { +typedef struct BACnetAuthenticationFactor { BACNET_AUTHENTICATION_FACTOR_TYPE format_type; uint32_t format_class; BACNET_OCTET_STRING value; } BACNET_AUTHENTICATION_FACTOR; - #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ diff --git a/src/bacnet/authentication_factor_format.c b/src/bacnet/authentication_factor_format.c index b8afae93..295333b3 100644 --- a/src/bacnet/authentication_factor_format.c +++ b/src/bacnet/authentication_factor_format.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2015 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief BACnet BACnetAuthenticationFactorFormat codecs + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #include #include "bacnet/bacdcode.h" #include "bacnet/authentication_factor_format.h" diff --git a/src/bacnet/authentication_factor_format.h b/src/bacnet/authentication_factor_format.h index 88cee5ad..74f42e4c 100644 --- a/src/bacnet/authentication_factor_format.h +++ b/src/bacnet/authentication_factor_format.h @@ -1,28 +1,10 @@ -/************************************************************************** -* -* Copyright (C) 2015 Nikola Jelic -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ - +/** + * @file + * @brief BACnet BACnetAuthenticationFactorFormat structure and codecs + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #ifndef BACNET_AUTHENTICATION_FACTOR_FORMAT_H #define BACNET_AUTHENTICATION_FACTOR_FORMAT_H @@ -31,7 +13,7 @@ /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" -typedef struct { +typedef struct BACnetAuthenticationFactorFormat { BACNET_AUTHENTICATION_FACTOR_TYPE format_type; uint32_t vendor_id, vendor_format; } BACNET_AUTHENTICATION_FACTOR_FORMAT; diff --git a/src/bacnet/awf.c b/src/bacnet/awf.c index 08578dc9..2f3637eb 100644 --- a/src/bacnet/awf.c +++ b/src/bacnet/awf.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2005 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet AtomicWriteFile service structures, codecs, and handlers. + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 +*/ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" @@ -38,8 +12,6 @@ #include "bacnet/bacdcode.h" #include "bacnet/awf.h" -/** @file awf.c Atomic Write File */ - /** * @brief Encode the AtomicWriteFile service request * diff --git a/src/bacnet/awf.h b/src/bacnet/awf.h index 04339b93..f7f1d4df 100644 --- a/src/bacnet/awf.h +++ b/src/bacnet/awf.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef ATOMIC_WRITE_FILE_H -#define ATOMIC_WRITE_FILE_H +/** + * @file + * @brief BACnet AtomicWriteFile service structures, codecs, and handlers. + * @author Steve Karg + * @date 2007 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_ATOMIC_WRITE_FILE_H +#define BACNET_ATOMIC_WRITE_FILE_H #include #include diff --git a/src/bacnet/bacaddr.c b/src/bacnet/bacaddr.c index 112a926b..f0ad4069 100644 --- a/src/bacnet/bacaddr.c +++ b/src/bacnet/bacaddr.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2007 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet Address structure utilities + * @author Steve Karg + * @date 2007 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include #include @@ -44,8 +18,6 @@ #include "bacnet/bacstr.h" #include "bacnet/bacaddr.h" -/** @file bacaddr.c BACnet Address structure utilities */ - /** * @brief Copy a #BACNET_ADDRESS value to another * @param dest - #BACNET_ADDRESS to be copied into diff --git a/src/bacnet/bacaddr.h b/src/bacnet/bacaddr.h index a988a422..ad36df74 100644 --- a/src/bacnet/bacaddr.h +++ b/src/bacnet/bacaddr.h @@ -1,28 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2012 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - *********************************************************************/ -#ifndef BACADDR_H -#define BACADDR_H +/** + * @file + * @brief BACnet address encode and decode helper functions + * @author Steve Karg + * @date 2007 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_ADDRESS_H +#define BACNET_ADDRESS_H #include #include diff --git a/src/bacnet/bacapp.c b/src/bacnet/bacapp.c index ec4af7e6..f3bb6aaa 100644 --- a/src/bacnet/bacapp.c +++ b/src/bacnet/bacapp.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2005 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief Utilities for the BACnet_Application_Data_Value + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include #include @@ -59,8 +33,6 @@ #include "bacnet/special_event.h" #include "bacnet/basic/sys/platform.h" -/** @file bacapp.c Utilities for the BACnet_Application_Data_Value */ - /** * @brief Encode application data given by a pointer into the APDU. * @param apdu - Pointer to the buffer to encode to, or NULL for length diff --git a/src/bacnet/bacapp.h b/src/bacnet/bacapp.h index 78c5bc2c..79575188 100644 --- a/src/bacnet/bacapp.h +++ b/src/bacnet/bacapp.h @@ -1,28 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2012 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - *********************************************************************/ -#ifndef BACAPP_H -#define BACAPP_H +/** + * @file + * @brief BACnet application data encode and decode helper functions + * @author Steve Karg + * @date 2007 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_APP_H +#define BACNET_APP_H #include #include diff --git a/src/bacnet/bacdcode.c b/src/bacnet/bacdcode.c index b88ce03d..fbc8367e 100644 --- a/src/bacnet/bacdcode.c +++ b/src/bacnet/bacdcode.c @@ -1,37 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2004 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ - +/** + * @file + * @brief BACnet primitive data encode and decode helper functions + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" @@ -41,8 +14,6 @@ #include "bacnet/bacint.h" #include "bacnet/bacreal.h" -/** @file bacdcode.c Functions to encode/decode BACnet data types */ - /* max-segments-accepted B'000' Unspecified number of segments accepted. B'001' 2 segments accepted. diff --git a/src/bacnet/bacdcode.h b/src/bacnet/bacdcode.h index 82fd6f41..3afad873 100644 --- a/src/bacnet/bacdcode.h +++ b/src/bacnet/bacdcode.h @@ -1,28 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2012 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - *********************************************************************/ -#ifndef BACDCODE_H -#define BACDCODE_H +/** + * @file + * @brief BACnet primitive data encode and decode helper functions + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_CODEC_H +#define BACNET_CODEC_H #include #include diff --git a/src/bacnet/bacdef.h b/src/bacnet/bacdef.h index 0e714aad..8957e04f 100644 --- a/src/bacnet/bacdef.h +++ b/src/bacnet/bacdef.h @@ -3,12 +3,10 @@ * @brief Core BACnet defines and enumerations and structures * @author Steve Karg * @date 2004 - * @copyright 2004 Steve Karg - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BACDEF_H -#define BACDEF_H +#ifndef BACNET_DEFINES_H +#define BACNET_DEFINES_H #include #include diff --git a/src/bacnet/bacdest.c b/src/bacnet/bacdest.c index 1c7f9138..9203381d 100644 --- a/src/bacnet/bacdest.c +++ b/src/bacnet/bacdest.c @@ -3,11 +3,7 @@ * @brief BACnetDestination complex data type encode and decode * @author Steve Karg * @date December 2022 - * @section LICENSE - * - * Copyright (C) 2022 Steve Karg - * - * SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 */ #include #include diff --git a/src/bacnet/bacdest.h b/src/bacnet/bacdest.h index 34ff9d82..9a62e03f 100644 --- a/src/bacnet/bacdest.h +++ b/src/bacnet/bacdest.h @@ -3,11 +3,7 @@ * @brief API for BACnetDestination complex data type encode and decode * @author Steve Karg * @date May 2022 - * @section LICENSE - * - * Copyright (C) 2022 Steve Karg - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #ifndef BACNET_DESTINATION_H #define BACNET_DESTINATION_H diff --git a/src/bacnet/bacdevobjpropref.c b/src/bacnet/bacdevobjpropref.c index 5ce179ce..600d1586 100644 --- a/src/bacnet/bacdevobjpropref.c +++ b/src/bacnet/bacdevobjpropref.c @@ -1,37 +1,11 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2008 John Minack - Copyright (C) 2022 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnetDeviceObjectPropertyReference structure, encode, decode + * @author John Minack + * @author Steve Karg + * @date 2008 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include #include "bacnet/bacdcode.h" @@ -39,9 +13,6 @@ #include "bacnet/timestamp.h" #include "bacnet/bacdevobjpropref.h" -/** @file bacdevobjpropref.c BACnet Application Device Object (Property) - * Reference */ - /** * Encode a property reference for the device object. * Add an opening tag, encode the property and finally diff --git a/src/bacnet/bacdevobjpropref.h b/src/bacnet/bacdevobjpropref.h index 6926afb1..cb2c4960 100644 --- a/src/bacnet/bacdevobjpropref.h +++ b/src/bacnet/bacdevobjpropref.h @@ -1,29 +1,13 @@ -/************************************************************************** - * - * Copyright (C) 2008 John Minack - * Copyright (C) 2022 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - *********************************************************************/ -#ifndef _BAC_DEV_PROP_REF_H_ -#define _BAC_DEV_PROP_REF_H_ +/** + * @file + * @brief BACnetDeviceObjectPropertyReference structure, encode, decode + * @author John Minack + * @author Steve Karg + * @date 2008 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_DEV_PROP_REF_H_ +#define BACNET_DEV_PROP_REF_H_ #include #include diff --git a/src/bacnet/bacenum.h b/src/bacnet/bacenum.h index a4ff99d9..9fb48f06 100644 --- a/src/bacnet/bacenum.h +++ b/src/bacnet/bacenum.h @@ -1,28 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2012 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - *********************************************************************/ -#ifndef BACENUM_H -#define BACENUM_H +/** + * @file + * @brief BACnet defines and enumerations + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_ENUMERATIONS_H +#define BACNET_ENUMERATIONS_H typedef enum { PROP_ACKED_TRANSITIONS = 0, diff --git a/src/bacnet/bacerror.c b/src/bacnet/bacerror.c index ddcc6add..9aa337ed 100644 --- a/src/bacnet/bacerror.c +++ b/src/bacnet/bacerror.c @@ -1,3 +1,10 @@ +/** + * @file + * @brief BACnet error encode and decode helper functions + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ /*####COPYRIGHTBEGIN#### ------------------------------------------- Copyright (C) 2005 Steve Karg diff --git a/src/bacnet/bacerror.h b/src/bacnet/bacerror.h index 054d8163..ecd53c63 100644 --- a/src/bacnet/bacerror.h +++ b/src/bacnet/bacerror.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef BACERROR_H -#define BACERROR_H +/** + * @file + * @brief BACnet error encode and decode helper functions + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_ERROR_H +#define BACNET_ERROR_H #include #include diff --git a/src/bacnet/bacint.c b/src/bacnet/bacint.c index 7c35d36d..c185b725 100644 --- a/src/bacnet/bacint.c +++ b/src/bacnet/bacint.c @@ -1,39 +1,11 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2004 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ - -/* BACnet Integer encoding and decoding */ +/** + * @file + * @brief BACnet integer encode and decode helper functions + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include /* BACnet Stack defines - first */ @@ -41,8 +13,6 @@ /* BACnet Stack API */ #include "bacnet/bacint.h" -/** @file bacint.c Encode/Decode Integer Types */ - int encode_unsigned16(uint8_t *apdu, uint16_t value) { if (apdu) { diff --git a/src/bacnet/bacint.h b/src/bacnet/bacint.h index 9a6f7fd1..b8868652 100644 --- a/src/bacnet/bacint.h +++ b/src/bacnet/bacint.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef BACINT_H -#define BACINT_H +/** + * @file + * @brief BACnet integer encode and decode helper functions + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_INTEGER_H +#define BACNET_INTEGER_H #include #include diff --git a/src/bacnet/bacprop.c b/src/bacnet/bacprop.c index 103ff544..1cda99f0 100644 --- a/src/bacnet/bacprop.c +++ b/src/bacnet/bacprop.c @@ -1,36 +1,11 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2005 John Goulah - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet property tag lookup functions + * @author John Goulah + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include #if PRINT_ENABLED @@ -38,8 +13,6 @@ #endif #include "bacnet/bacprop.h" -/** @file bacprop.c Lookup BACnet Property Tags */ - PROP_TAG_DATA bacnet_object_device_property_tag_map[] = { { PROP_OBJECT_IDENTIFIER, BACNET_APPLICATION_TAG_OBJECT_ID }, { PROP_OBJECT_NAME, BACNET_APPLICATION_TAG_CHARACTER_STRING }, diff --git a/src/bacnet/bacprop.h b/src/bacnet/bacprop.h index 674f7913..ba08231f 100644 --- a/src/bacnet/bacprop.h +++ b/src/bacnet/bacprop.h @@ -1,28 +1,13 @@ -/************************************************************************** -* -* Copyright (C) 2005 John Goulah -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef BACPROP_H -#define BACPROP_H +/** + * @file + * @brief BACnet property tag lookup functions + * @author John Goulah + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_PROPERTY_H +#define BACNET_PROPERTY_H #include #include diff --git a/src/bacnet/bacpropstates.c b/src/bacnet/bacpropstates.c index c681049f..4100b549 100644 --- a/src/bacnet/bacpropstates.c +++ b/src/bacnet/bacpropstates.c @@ -1,44 +1,17 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2008 John Minack - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet property state encode and decode functions + * @author Steve Karg + * @author John Minack + * @date 2008 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include "bacnet/bacdcode.h" #include "bacnet/npdu.h" #include "bacnet/timestamp.h" #include "bacnet/bacpropstates.h" -/** @file bacpropstates.c Encode/Decode BACnet Application Property States */ - /** * @brief Decodes BACnetPropertyState from bytes into a data structure * diff --git a/src/bacnet/bacpropstates.h b/src/bacnet/bacpropstates.h index 05abe568..a3cbb086 100644 --- a/src/bacnet/bacpropstates.h +++ b/src/bacnet/bacpropstates.h @@ -1,28 +1,13 @@ -/************************************************************************** -* -* Copyright (C) 2008 John Minack -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef _BAC_PROP_STATES_H_ -#define _BAC_PROP_STATES_H_ +/** + * @file + * @brief BACnet property state encode and decode functions + * @author Steve Karg + * @author John Minack + * @date 2008 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_PROPERTY_STATES_H_ +#define BACNET_PROPERTY_STATES_H_ #include #include diff --git a/src/bacnet/bacreal.c b/src/bacnet/bacreal.c index a4eae025..2a0c90ea 100644 --- a/src/bacnet/bacreal.c +++ b/src/bacnet/bacreal.c @@ -1,37 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2004-2008 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ - +/** + * @file + * @brief BACnet single precision REAL encode and decode functions + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" diff --git a/src/bacnet/bacreal.h b/src/bacnet/bacreal.h index 2068afb3..cfaf7072 100644 --- a/src/bacnet/bacreal.h +++ b/src/bacnet/bacreal.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef BACREAL_H -#define BACREAL_H +/** + * @file + * @brief BACnet single precision REAL encode and decode functions + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_REAL_H +#define BACNET_REAL_H #include #include diff --git a/src/bacnet/bacstr.c b/src/bacnet/bacstr.c index 753344ca..20b9cc91 100644 --- a/src/bacnet/bacstr.c +++ b/src/bacnet/bacstr.c @@ -1,37 +1,11 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2004 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ - +/** + * @file + * @brief BACnet bitstring, octectstring, and characterstring encode + * and decode functions + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include #include @@ -43,7 +17,6 @@ /* BACnet Stack API */ #include "bacnet/bacstr.h" -/** @file bacstr.c Manipulate Bit/Char/Octet Strings */ #ifndef BACNET_STRING_UTF8_VALIDATION #define BACNET_STRING_UTF8_VALIDATION 1 #endif diff --git a/src/bacnet/bacstr.h b/src/bacnet/bacstr.h index 8ea4e742..ab49fb49 100644 --- a/src/bacnet/bacstr.h +++ b/src/bacnet/bacstr.h @@ -1,28 +1,13 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef BACSTR_H -#define BACSTR_H +/** + * @file + * @brief BACnet bitstring, octectstring, and characterstring encode + * and decode functions + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_STRING_H +#define BACNET_STRING_H #include #include diff --git a/src/bacnet/bactext.c b/src/bacnet/bactext.c index 3edf8cf3..f5ce68bf 100644 --- a/src/bacnet/bactext.c +++ b/src/bacnet/bactext.c @@ -1,45 +1,16 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2005-2006 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ - +/** + * @file + * @brief Lookup or Translate BACnet Name Text + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include #include "bacnet/indtext.h" #include "bacnet/bacenum.h" #include "bacnet/bactext.h" -/** @file bactext.c Lookup or Translate BACnet Name Text */ - static const char *ASHRAE_Reserved_String = "Reserved for Use by ASHRAE"; static const char *Vendor_Proprietary_String = "Vendor Proprietary Value"; diff --git a/src/bacnet/bactext.h b/src/bacnet/bactext.h index e89d738e..afddbac9 100644 --- a/src/bacnet/bactext.h +++ b/src/bacnet/bactext.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef BACTEXT_H -#define BACTEXT_H +/** + * @file + * @brief BACnet text enumerations lookup functions + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_TEXT_H +#define BACNET_TEXT_H /* tiny implementations have no need to print */ #if PRINT_ENABLED diff --git a/src/bacnet/bactimevalue.h b/src/bacnet/bactimevalue.h index 15c3fce3..a6e45908 100644 --- a/src/bacnet/bactimevalue.h +++ b/src/bacnet/bactimevalue.h @@ -1,29 +1,13 @@ -/************************************************************************** -* -* Copyright (C) 2015 Nikola Jelic -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ - -#ifndef _BAC_TIME_VALUE_H_ -#define _BAC_TIME_VALUE_H_ +/** + * @file + * @brief BACnet time-value encode and decode functions + * @author Nikola Jelic + * @author Steve Karg + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_TIME_VALUE_H_ +#define BACNET_TIME_VALUE_H_ #include #include diff --git a/src/bacnet/basic/bbmd/h_bbmd.c b/src/bacnet/basic/bbmd/h_bbmd.c index 2b06c9cd..f072629f 100644 --- a/src/bacnet/basic/bbmd/h_bbmd.c +++ b/src/bacnet/basic/bbmd/h_bbmd.c @@ -1,37 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2020 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ - +/** + * @file + * @brief BBMD (BACnet Broadcast Management Device) for BACnet/IPv4 + * @author Steve Karg + * @date 2020 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* for standard i/o, like printing */ #include /* for standard integer types uint8_t etc. */ #include /* for the standard bool type. */ @@ -527,7 +500,7 @@ static void bbmd_read_bdt_ack_handler( break; } } -#else +#else (void)addr; (void)npdu; (void)npdu_length; diff --git a/src/bacnet/basic/bbmd/h_bbmd.h b/src/bacnet/basic/bbmd/h_bbmd.h index 4d12809b..d3d39a4b 100644 --- a/src/bacnet/basic/bbmd/h_bbmd.h +++ b/src/bacnet/basic/bbmd/h_bbmd.h @@ -1,33 +1,12 @@ /** * @file + * @brief Header file for a basic BBMD for BVLC IPv4 handler * @author Steve Karg * @date February 2020 - * @brief Header file for a basic BBMD for BVLC IPv4 handler - * - * @section LICENSE - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BVLC_HANDLER_H -#define BVLC_HANDLER_H - +#ifndef BACNET_BASIC_BVLC_HANDLER_H +#define BACNET_BASIC_BVLC_HANDLER_H #include #include #include diff --git a/src/bacnet/basic/bbmd6/h_bbmd6.c b/src/bacnet/basic/bbmd6/h_bbmd6.c index 8e981305..39ac3cff 100644 --- a/src/bacnet/basic/bbmd6/h_bbmd6.c +++ b/src/bacnet/basic/bbmd6/h_bbmd6.c @@ -1,37 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2016 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ - +/** + * @file + * @brief BBMD (BACnet Broadcast Management Device) for BACnet/IPv6 + * @author Steve Karg + * @date 2016 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* for standard i/o, like printing */ #include /* for standard integer types uint8_t etc. */ #include /* for the standard bool type. */ @@ -128,7 +101,7 @@ void bvlc6_maintenance_timer(uint16_t seconds) } } #else - (void)seconds; + (void)seconds; #endif } @@ -205,13 +178,13 @@ static void bbmd6_add_vmac(uint32_t device_id, BACNET_IP6_ADDRESS *addr) } else { /* VMAC exists, but device ID changed */ VMAC_Delete(list_device_id); - PRINTF("BVLC6: VMAC existed for %u [", + PRINTF("BVLC6: VMAC existed for %u [", (unsigned int)list_device_id); for (i = 0; i < new_vmac.mac_len; i++) { PRINTF("%02X", new_vmac.mac[i]); } PRINTF("]\n"); - PRINTF("BVLC6: Removed VMAC for %lu.\n", + PRINTF("BVLC6: Removed VMAC for %lu.\n", (unsigned long)list_device_id); } } @@ -220,24 +193,24 @@ static void bbmd6_add_vmac(uint32_t device_id, BACNET_IP6_ADDRESS *addr) if (vmac) { /* device ID already exists. Update MAC. */ memmove(vmac, &new_vmac, sizeof(struct vmac_data)); - PRINTF("BVLC6: VMAC for %u [", + PRINTF("BVLC6: VMAC for %u [", (unsigned int)device_id); for (i = 0; i < new_vmac.mac_len; i++) { PRINTF("%02X", new_vmac.mac[i]); } PRINTF("]\n"); - PRINTF("BVLC6: Updated VMAC for %lu.\n", + PRINTF("BVLC6: Updated VMAC for %lu.\n", (unsigned long)device_id); } else { /* new entry - add it! */ VMAC_Add(device_id, &new_vmac); - PRINTF("BVLC6: VMAC for %u [", + PRINTF("BVLC6: VMAC for %u [", (unsigned int)device_id); for (i = 0; i < new_vmac.mac_len; i++) { PRINTF("%02X", new_vmac.mac[i]); } PRINTF("]\n"); - PRINTF("BVLC6: Added VMAC for %lu.\n", + PRINTF("BVLC6: Added VMAC for %lu.\n", (unsigned long)device_id); } } diff --git a/src/bacnet/basic/bbmd6/h_bbmd6.h b/src/bacnet/basic/bbmd6/h_bbmd6.h index 991fdf38..c396d7d8 100644 --- a/src/bacnet/basic/bbmd6/h_bbmd6.h +++ b/src/bacnet/basic/bbmd6/h_bbmd6.h @@ -1,33 +1,12 @@ /** -* @file -* @author Steve Karg -* @date October 2019 -* @brief Header file for a basic BBMD for BVLC IPv6 handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef BVLC6_HANDLER_H -#define BVLC6_HANDLER_H - + * @file + * @brief Header file for a basic BBMD for BVLC IPv6 handler + * @author Steve Karg + * @date October 2016 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_BVLC6_HANDLER_H +#define BACNET_BASIC_BVLC6_HANDLER_H #include #include #include diff --git a/src/bacnet/basic/bbmd6/vmac.c b/src/bacnet/basic/bbmd6/vmac.c index 1bdd40cc..1f6595c2 100644 --- a/src/bacnet/basic/bbmd6/vmac.c +++ b/src/bacnet/basic/bbmd6/vmac.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2015 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief Virtual MAC (VMAC) for BACnet/IPv6 neighbors + * @author Steve Karg + * @date 2016 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include #include diff --git a/src/bacnet/basic/bbmd6/vmac.h b/src/bacnet/basic/bbmd6/vmac.h index c37aafe7..5b27b7a9 100644 --- a/src/bacnet/basic/bbmd6/vmac.h +++ b/src/bacnet/basic/bbmd6/vmac.h @@ -1,10 +1,12 @@ /** -* @file -* @author Steve Karg -* @date 2016 -*/ -#ifndef VMAC_H -#define VMAC_H + * @file + * @brief API for Virtual MAC (VMAC) of BACnet/IPv6 neighbors + * @author Steve Karg + * @date 2016 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_BBMD6_VMAC_H +#define BACNET_BASIC_BBMD6_VMAC_H #include #include @@ -19,7 +21,7 @@ * @{ */ struct vmac_data { - uint8_t mac[18]; + uint8_t mac[VMAC_MAC_MAX]; uint8_t mac_len; }; /** @} */ diff --git a/src/bacnet/basic/binding/address.c b/src/bacnet/basic/binding/address.c index 4cfe0524..f4676d9c 100644 --- a/src/bacnet/basic/binding/address.c +++ b/src/bacnet/basic/binding/address.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2004 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief Handle device instance and NPDU address binding + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include #include @@ -51,8 +25,6 @@ #endif #endif -/** @file address.c Handle address binding */ - /* This module is used to handle the address binding that */ /* occurs in BACnet. A device id is bound to a MAC address. */ /* The normal method is using Who-Is, and using the data from I-Am */ diff --git a/src/bacnet/basic/binding/address.h b/src/bacnet/basic/binding/address.h index f91d3d8c..60d3d1f0 100644 --- a/src/bacnet/basic/binding/address.h +++ b/src/bacnet/basic/binding/address.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef ADDRESS_H -#define ADDRESS_H +/** + * @file + * @brief API for basic BACnet address binding table + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_ADDRESS_H +#define BACNET_BASIC_ADDRESS_H #include #include diff --git a/src/bacnet/basic/client/bac-data.c b/src/bacnet/basic/client/bac-data.c index f596162a..0e32b661 100644 --- a/src/bacnet/basic/client/bac-data.c +++ b/src/bacnet/basic/client/bac-data.c @@ -3,8 +3,7 @@ * @author Steve Karg * @date 2013 * @brief Store properties from other BACnet devices - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/client/bac-data.h b/src/bacnet/basic/client/bac-data.h index 0d8985e7..c4ede763 100644 --- a/src/bacnet/basic/client/bac-data.h +++ b/src/bacnet/basic/client/bac-data.h @@ -1,12 +1,12 @@ /** * @file + * @brief API for basic BACnet data handling * @author Steve Karg * @date 2013 - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BAC_DATA_H -#define BAC_DATA_H +#ifndef BACNET_BASIC_CLIENT_DATA_H +#define BACNET_BASIC_CLIENT_DATA_H #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/client/bac-discover.c b/src/bacnet/basic/client/bac-discover.c index e873b82c..1dff4980 100644 --- a/src/bacnet/basic/client/bac-discover.c +++ b/src/bacnet/basic/client/bac-discover.c @@ -1,10 +1,9 @@ /** * @file + * @brief Discover all BACnet devices on a destination network * @author Steve Karg * @date 2024 - * @brief Discover all BACnet devices on a destination network - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/client/bac-discover.h b/src/bacnet/basic/client/bac-discover.h index 25c62791..1cfb4ca9 100644 --- a/src/bacnet/basic/client/bac-discover.h +++ b/src/bacnet/basic/client/bac-discover.h @@ -1,13 +1,12 @@ /** * @file + * @brief API for basic BACnet client device discovery * @author Steve Karg * @date 2024 - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BAC_DISCOVER_H -#define BAC_DISCOVER_H - +#ifndef BACNET_BASIC_CLIENT_DISCOVER_H +#define BACNET_BASIC_CLIENT_DISCOVER_H #include #include /* BACnet Stack defines - first */ @@ -48,7 +47,7 @@ uint32_t bacnet_discover_device_instance(unsigned index); BACNET_STACK_EXPORT int bacnet_discover_device_object_count(uint32_t device_id); BACNET_STACK_EXPORT -bool bacnet_discover_device_object_identifier(uint32_t device_id, +bool bacnet_discover_device_object_identifier(uint32_t device_id, unsigned index, BACNET_OBJECT_ID *object_id); BACNET_STACK_EXPORT unsigned long bacnet_discover_device_elapsed_milliseconds( @@ -63,10 +62,10 @@ unsigned int bacnet_discover_object_property_count( uint32_t object_instance); BACNET_STACK_EXPORT bool bacnet_discover_object_property_identifier( - uint32_t device_id, + uint32_t device_id, BACNET_OBJECT_TYPE object_type, uint32_t object_instance, - unsigned index, + unsigned index, uint32_t *property_id); BACNET_STACK_EXPORT bool bacnet_discover_property_value(uint32_t device_id, diff --git a/src/bacnet/basic/client/bac-rw.c b/src/bacnet/basic/client/bac-rw.c index 167c8fb2..b1e2fe86 100644 --- a/src/bacnet/basic/client/bac-rw.c +++ b/src/bacnet/basic/client/bac-rw.c @@ -1,10 +1,9 @@ /** * @file - * @author Steve Karg - * @date 2013 * @brief Read properties from other BACnet devices, and store their values - * - * SPDX-License-Identifier: MIT + * @author Steve Karg + * @date 2022 + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/client/bac-rw.h b/src/bacnet/basic/client/bac-rw.h index db6b7f2f..b59745b9 100644 --- a/src/bacnet/basic/client/bac-rw.h +++ b/src/bacnet/basic/client/bac-rw.h @@ -1,13 +1,12 @@ /** * @file + * @brief API to read properties from other BACnet devices * @author Steve Karg - * @date 2013 - * - * SPDX-License-Identifier: MIT + * @date 2022 + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BAC_RW_H -#define BAC_RW_H - +#ifndef BACNET_BASIC_CLIENT_READ_WRITE_H +#define BACNET_BASIC_CLIENT_READ_WRITE_H #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" diff --git a/src/bacnet/basic/client/bac-task.c b/src/bacnet/basic/client/bac-task.c index 0551c109..c25a9fa5 100644 --- a/src/bacnet/basic/client/bac-task.c +++ b/src/bacnet/basic/client/bac-task.c @@ -1,10 +1,9 @@ /** * @file - * @author Steve Karg - * @date 2013 * @brief High level BACnet Task handling - * - * SPDX-License-Identifier: MIT + * @author Steve Karg + * @date 2022 + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/client/bac-task.h b/src/bacnet/basic/client/bac-task.h index de1809af..c17a9feb 100644 --- a/src/bacnet/basic/client/bac-task.h +++ b/src/bacnet/basic/client/bac-task.h @@ -1,14 +1,12 @@ /** * @file - * @author Steve Karg - * @date 2013 - * @brief High level BACnet task handling - * - * SPDX-License-Identifier: MIT + * @brief API for high level BACnet Task handling + * @author Steve Karg + * @date 2022 + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BACNET_TASK_H -#define BACNET_TASK_H - +#ifndef BACNET_BASIC_CLIENT_TASK_H +#define BACNET_BASIC_CLIENT_TASK_H #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" diff --git a/src/bacnet/basic/npdu/h_npdu.c b/src/bacnet/basic/npdu/h_npdu.c index 848c92d3..7a63f381 100644 --- a/src/bacnet/basic/npdu/h_npdu.c +++ b/src/bacnet/basic/npdu/h_npdu.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2008 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief Handling for the basic BACnet NPDU layer of the BACnet stack + * @author Steve Karg + * @date 2008 + * @copyright SPDX-License-Identifier: MIT + */ #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/npdu/h_npdu.h b/src/bacnet/basic/npdu/h_npdu.h index 1c7e52c5..7368f2a7 100644 --- a/src/bacnet/basic/npdu/h_npdu.h +++ b/src/bacnet/basic/npdu/h_npdu.h @@ -1,33 +1,12 @@ /** -* @file -* @author Steve Karg -* @date October 2019 -* @brief Header file for a basic NPDU handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef NPDU_HANDLER_H -#define NPDU_HANDLER_H - + * @file + * @brief Header file for a basic NPDU handler + * @author Steve Karg + * @date October 2019 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_NPDU_HANDLER_H +#define BACNET_BASIC_NPDU_HANDLER_H #include #include #include diff --git a/src/bacnet/basic/npdu/h_routed_npdu.c b/src/bacnet/basic/npdu/h_routed_npdu.c index 885320c0..c34c48a0 100644 --- a/src/bacnet/basic/npdu/h_routed_npdu.c +++ b/src/bacnet/basic/npdu/h_routed_npdu.c @@ -1,30 +1,13 @@ -/************************************************************************** - * - * Copyright (C) 2010 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ -/* Acknowledging the contribution of code and ideas used here that - * came from Paul Chapman's vmac demo project. */ - +/** + * @file + * @brief Handles messages at the NPDU level of the BACnet + * stack, including routing and network control messages. + * @author Tom Brennan + * @note Acknowledging the contribution of code and ideas used here that + * came from Paul Chapman's vmac demo project. + * @date 2010 + * @copyright SPDX-License-Identifier: MIT + */ #include #include /* BACnet Stack defines - first */ @@ -44,9 +27,6 @@ #include #endif -/** @file h_routed_npdu.c Handles messages at the NPDU level of the BACnet - * stack, including routing and network control messages. */ - /** Handler to manage the Network Layer Control Messages received in a packet. * This handler is called if the NCPI bit 7 indicates that this packet is a * network layer message and there is no further DNET to pass it to. diff --git a/src/bacnet/basic/npdu/h_routed_npdu.h b/src/bacnet/basic/npdu/h_routed_npdu.h index 8ee8893e..102e8571 100644 --- a/src/bacnet/basic/npdu/h_routed_npdu.h +++ b/src/bacnet/basic/npdu/h_routed_npdu.h @@ -1,33 +1,12 @@ /** -* @file -* @author Steve Karg -* @date October 2019 -* @brief Header file for a basic routing NPDU handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef ROUTING_NPDU_HANDLER_H -#define ROUTING_NPDU_HANDLER_H - + * @file + * @author Steve Karg + * @date October 2019 + * @brief Header file for a basic routing NPDU handler + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_NPDU_ROUTED_HANDLER_H +#define BACNET_BASIC_NPDU_ROUTED_HANDLER_H #include #include #include diff --git a/src/bacnet/basic/npdu/s_router.c b/src/bacnet/basic/npdu/s_router.c index f717f533..9db08356 100644 --- a/src/bacnet/basic/npdu/s_router.c +++ b/src/bacnet/basic/npdu/s_router.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2005 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief Methods to send various BACnet Router Network Layer Messages. + * @author Tom Brennan + * @date 2010 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -40,9 +23,6 @@ #include "bacnet/basic/sys/debug.h" #include "bacnet/basic/services.h" -/** @file s_router.c Methods to send various BACnet Router Network Layer - * Messages. */ - /** Function to encode and send any supported Network Layer Message. * The payload for the message is encoded from information in the iArgs[] array. * The contents of iArgs are are, per message type: diff --git a/src/bacnet/basic/npdu/s_router.h b/src/bacnet/basic/npdu/s_router.h index ef116b6d..64010e4d 100644 --- a/src/bacnet/basic/npdu/s_router.h +++ b/src/bacnet/basic/npdu/s_router.h @@ -3,31 +3,10 @@ * @author Steve Karg * @date October 2019 * @brief Header file for a basic WritePropertyMultiple service send -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +* @copyright SPDX-License-Identifier: MIT */ -#ifndef SEND_ROUTER_H -#define SEND_ROUTER_H - +#ifndef BACNET_BASIC_NPDU_SEND_ROUTER_H +#define BACNET_BASIC_NPDU_SEND_ROUTER_H #include #include #include diff --git a/src/bacnet/basic/object/acc.c b/src/bacnet/basic/object/acc.c index 44c8cf26..b84ce9c1 100644 --- a/src/bacnet/basic/object/acc.c +++ b/src/bacnet/basic/object/acc.c @@ -1,11 +1,9 @@ /** * @file * @brief BACnet accumulator Objects used to represent meter registers - * @author Steve Karg + * @author Steve Karg * @date 2017 - * @copyright 2017 Steve Karg - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/acc.h b/src/bacnet/basic/object/acc.h index 763ad97c..ef69eb9e 100644 --- a/src/bacnet/basic/object/acc.h +++ b/src/bacnet/basic/object/acc.h @@ -1,11 +1,9 @@ /** * @file * @brief Accumulator object header file - * @author Steve Karg + * @author Steve Karg * @date 2017 - * @copyright 2017 Steve Karg - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #ifndef BACNET_BASIC_OBJECT_ACCUMULATOR_H #define BACNET_BASIC_OBJECT_ACCUMULATOR_H diff --git a/src/bacnet/basic/object/access_credential.c b/src/bacnet/basic/object/access_credential.c index bacf07f4..403fe2eb 100644 --- a/src/bacnet/basic/object/access_credential.c +++ b/src/bacnet/basic/object/access_credential.c @@ -1,30 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2015 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the credential to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* Access Credential Objects - customize for your use */ - +/** + * @file + * @brief A basic BACnet Access Credential Object implementation. + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/object/access_credential.h b/src/bacnet/basic/object/access_credential.h index 070c0a50..38a12fc0 100644 --- a/src/bacnet/basic/object/access_credential.h +++ b/src/bacnet/basic/object/access_credential.h @@ -1,30 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2015 Nikola Jelic -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef ACCESS_CREDENTIAL_H -#define ACCESS_CREDENTIAL_H - +/** + * @file + * @brief API for basic BACnet Access Credential Object implementation. + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_ACCESS_CREDENTIAL_H +#define BACNET_BASIC_OBJECT_ACCESS_CREDENTIAL_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/access_door.c b/src/bacnet/basic/object/access_door.c index 6b6a5353..7d6b694f 100644 --- a/src/bacnet/basic/object/access_door.c +++ b/src/bacnet/basic/object/access_door.c @@ -1,30 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2015 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* Access Door Objects - customize for your use */ - +/** + * @file + * @brief A basic BACnet Access Door Objects implementation. + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/object/access_door.h b/src/bacnet/basic/object/access_door.h index 8c8fa849..fd886273 100644 --- a/src/bacnet/basic/object/access_door.h +++ b/src/bacnet/basic/object/access_door.h @@ -1,29 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2015 Nikola Jelic -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef ACCESS_DOOR_H -#define ACCESS_DOOR_H +/** + * @file + * @brief API for basic BACnet Access Door Objects implementation. + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_ACCESS_DOOR_H +#define BACNET_BASIC_OBJECT_ACCESS_DOOR_H #include #include diff --git a/src/bacnet/basic/object/access_point.c b/src/bacnet/basic/object/access_point.c index d31625b9..ff9ea7f0 100644 --- a/src/bacnet/basic/object/access_point.c +++ b/src/bacnet/basic/object/access_point.c @@ -1,30 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2015 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* Access Point Objects - customize for your use */ - +/** + * @file + * @brief A basic BACnet Access Point Objects implementation. + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/object/access_point.h b/src/bacnet/basic/object/access_point.h index feed9f28..cc1edce8 100644 --- a/src/bacnet/basic/object/access_point.h +++ b/src/bacnet/basic/object/access_point.h @@ -1,29 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2015 Nikola Jelic -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef ACCESS_POINT_H -#define ACCESS_POINT_H +/** + * @file + * @brief API for basic BACnet Access Point Objects implementation. + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_ACCESS_POINT_H +#define BACNET_BASIC_OBJECT_ACCESS_POINT_H #include #include diff --git a/src/bacnet/basic/object/access_rights.c b/src/bacnet/basic/object/access_rights.c index f0bd1651..b80e2a21 100644 --- a/src/bacnet/basic/object/access_rights.c +++ b/src/bacnet/basic/object/access_rights.c @@ -1,30 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2015 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* Access Rights Objects - customize for your use */ - +/** + * @file + * @brief A basic BACnet Access Rights Objects implementation. + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/object/access_rights.h b/src/bacnet/basic/object/access_rights.h index b08c70b2..79493f72 100644 --- a/src/bacnet/basic/object/access_rights.h +++ b/src/bacnet/basic/object/access_rights.h @@ -1,29 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2015 Nikola Jelic -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef ACCESS_RIGHTS_H -#define ACCESS_RIGHTS_H +/** + * @file + * @brief API for basic BACnet Access Rights Objects implementation. + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_ACCESS_RIGHTS_H +#define BACNET_BASIC_OBJECT_ACCESS_RIGHTS_H #include #include diff --git a/src/bacnet/basic/object/access_user.c b/src/bacnet/basic/object/access_user.c index 9855b8fa..7e229f67 100644 --- a/src/bacnet/basic/object/access_user.c +++ b/src/bacnet/basic/object/access_user.c @@ -1,30 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2015 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* Access User Objects - customize for your use */ - +/** + * @file + * @brief A basic BACnet Access User Object implementation. + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/object/access_user.h b/src/bacnet/basic/object/access_user.h index aa421585..d5041e09 100644 --- a/src/bacnet/basic/object/access_user.h +++ b/src/bacnet/basic/object/access_user.h @@ -1,29 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2015 Nikola Jelic -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef ACCESS_USER_H -#define ACCESS_USER_H +/** + * @file + * @brief API for basic BACnet Access User Object implementation. + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_ACCESS_USER_H +#define BACNET_BASIC_OBJECT_ACCESS_USER_H #include #include diff --git a/src/bacnet/basic/object/access_zone.c b/src/bacnet/basic/object/access_zone.c index ebb9723a..e66bcff5 100644 --- a/src/bacnet/basic/object/access_zone.c +++ b/src/bacnet/basic/object/access_zone.c @@ -1,30 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2015 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* Access Zone Objects - customize for your use */ - +/** + * @file + * @brief A basic BACnet Access Zone Objects implementation. + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/object/access_zone.h b/src/bacnet/basic/object/access_zone.h index 01976bb2..5572b19b 100644 --- a/src/bacnet/basic/object/access_zone.h +++ b/src/bacnet/basic/object/access_zone.h @@ -1,29 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2015 Nikola Jelic -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef ACCESS_ZONE_H -#define ACCESS_ZONE_H +/** + * @file + * @brief A basic BACnet Access Zone Objects implementation. + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_ACCESS_ZONE_H +#define BACNET_BASIC_OBJECT_ACCESS_ZONE_H #include #include diff --git a/src/bacnet/basic/object/ai.c b/src/bacnet/basic/object/ai.c index 34b4e34b..09c6db23 100644 --- a/src/bacnet/basic/object/ai.c +++ b/src/bacnet/basic/object/ai.c @@ -1,15 +1,10 @@ /** * @file - * @brief Analog Input Objects - customize for your use + * @brief A basic BACnet Analog Input Object implementation. * @author Steve Karg * @author Krzysztof Malorny - * @date 2005 - * @section LICENSE - * - * Copyright (C) 2005 Steve Karg - * Copyright (C) 2011 Krzysztof Malorny - * - * SPDX-License-Identifier: MIT + * @date 2005, 2011 + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/ai.h b/src/bacnet/basic/object/ai.h index 7adb4b42..80a9bb65 100644 --- a/src/bacnet/basic/object/ai.h +++ b/src/bacnet/basic/object/ai.h @@ -1,30 +1,13 @@ -/************************************************************************** -* -* Copyright (C) 2005 Steve Karg -* Copyright (C) 2011 Krzysztof Malorny -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef AI_H -#define AI_H +/** + * @file + * @brief API for basic BACnet Analog Input Object implementation. + * @author Steve Karg + * @author Krzysztof Malorny + * @date 2005, 2011 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_ANALOG_INPUT_H +#define BACNET_BASIC_OBJECT_ANALOG_INPUT_H #include #include diff --git a/src/bacnet/basic/object/ao.c b/src/bacnet/basic/object/ao.c index a9a105f3..7b527a69 100644 --- a/src/bacnet/basic/object/ao.c +++ b/src/bacnet/basic/object/ao.c @@ -1,35 +1,11 @@ /** * @file - * @author Steve Karg + * @brief A basic BACnet Analog Output Object implementation. + * An Analog Output object is an object with a present-value that + * uses an single precision floating point data type. + * @author Steve Karg * @date 2005 - * @brief Analog Output objects, customize for your use - * - * @section DESCRIPTION - * - * The Analog Output object is an object with a present-value that - * uses a single precision floating point data type, and includes - * a present-value derived from the priority array. - * - * @section LICENSE - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/ao.h b/src/bacnet/basic/object/ao.h index 4e247279..948106e9 100644 --- a/src/bacnet/basic/object/ao.h +++ b/src/bacnet/basic/object/ao.h @@ -2,38 +2,15 @@ * @file * @author Steve Karg * @date 2005 - * @brief Analog Output objects, customize for your use - * - * @section DESCRIPTION - * - * The Analog Output object is an object with a present-value that - * uses a single precision floating point data type, and includes - * a present-value derived from the priority array. - * - * @section LICENSE - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * @brief API for a basic BACnet Analog Output Object implementation. + * An Analog Output object is an object with a present-value that + * uses an single precision floating point data type. + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BACNET_ANALOG_OUTPUT_H -#define BACNET_ANALOG_OUTPUT_H - +#ifndef BACNET_BASIC_OBJECT_ANALOG_OUTPUT_H +#define BACNET_BASIC_OBJECT_ANALOG_OUTPUT_H #include #include #include "bacnet/bacdef.h" /* Must be before all other bacnet *.h files */ diff --git a/src/bacnet/basic/object/av.c b/src/bacnet/basic/object/av.c index 21898413..40f7b7f0 100644 --- a/src/bacnet/basic/object/av.c +++ b/src/bacnet/basic/object/av.c @@ -1,13 +1,12 @@ /** * @file - * @author Steve Karg - * @date 2006 - * @brief Analog Value object is an input object with a present-value that + * @brief A basic BACnet Analog Input Object implementation. + * An analog value object is an I/O object with a present-value that * uses an single precision floating point data type. - * @section LICENSE - * Copyright (C) 2006 Steve Karg - * Copyright (C) 2011 Krzysztof Malorny - * SPDX-License-Identifier: MIT + * @author Steve Karg + * @author Krzysztof Malorny + * @date 2006, 2011 + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/av.h b/src/bacnet/basic/object/av.h index 66e0de59..6dab34fa 100644 --- a/src/bacnet/basic/object/av.h +++ b/src/bacnet/basic/object/av.h @@ -2,15 +2,13 @@ * @file * @author Steve Karg * @date 2006 - * @brief Analog Value object is an input object with a present-value that - * uses an single precision floating point data type. - * @section LICENSE - * Copyright (C) 2006 Steve Karg - * Copyright (C) 2011 Krzysztof Malorny - * SPDX-License-Identifier: MIT + * @brief API for a basic BACnet Analog Input Object implementation. + * An analog value object is an I/O object with a present-value that + * uses a single precision floating point data type. + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BACNET_ANALOG_VALUE_OBJECT_H -#define BACNET_ANALOG_VALUE_OBJECT_H +#ifndef BACNET_BASIC_OBJECT_ANALOG_VALUE_H +#define BACNET_BASIC_OBJECT_ANALOG_VALUE_H #include #include diff --git a/src/bacnet/basic/object/bacfile.c b/src/bacnet/basic/object/bacfile.c index d37ff7eb..d0a6d919 100644 --- a/src/bacnet/basic/object/bacfile.c +++ b/src/bacnet/basic/object/bacfile.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2005 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @author Steve Karg + * @date 2005 + * @brief A basic BACnet File Object implementation. + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/object/bacfile.h b/src/bacnet/basic/object/bacfile.h index 3b36ba5a..a468bcb2 100644 --- a/src/bacnet/basic/object/bacfile.h +++ b/src/bacnet/basic/object/bacfile.h @@ -1,39 +1,12 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2005 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ -#ifndef BACFILE_H -#define BACFILE_H - +/** + * @file + * @author Steve Karg + * @date 2005 + * @brief API for a basic BACnet File Object implementation. + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_FILE_H +#define BACNET_BASIC_OBJECT_FILE_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/bi.c b/src/bacnet/basic/object/bi.c index fd2dceb1..71b9f473 100644 --- a/src/bacnet/basic/object/bi.c +++ b/src/bacnet/basic/object/bi.c @@ -1,12 +1,11 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2006 - * @brief Binary Input object is an input object with a present-value that + * @brief A basic BACnet Binary Input Object implementation. + * Binary Input objects are input objects with a present-value that * uses an enumerated two state active/inactive data type. - * @section LICENSE - * Copyright (C) 2006 Steve Karg - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/bi.h b/src/bacnet/basic/object/bi.h index 62a36fab..7a49ea24 100644 --- a/src/bacnet/basic/object/bi.h +++ b/src/bacnet/basic/object/bi.h @@ -1,16 +1,14 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2006 - * @brief Binary Input object is an input object with a present-value that + * @brief A basic BACnet Binary Input Object implementation. + * Binary Input objects are input objects with a present-value that * uses an enumerated two state active/inactive data type. - * @section LICENSE - * Copyright (C) 2006 Steve Karg - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BACNET_BINARY_INPUT_OBJECT_H -#define BACNET_BINARY_INPUT_OBJECT_H - +#ifndef BACNET_BASIC_OBJECT_BINARY_INPUT_H +#define BACNET_BASIC_OBJECT_BINARY_INPUT_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/bitstring_value.h b/src/bacnet/basic/object/bitstring_value.h index 19fc280f..ba777369 100644 --- a/src/bacnet/basic/object/bitstring_value.h +++ b/src/bacnet/basic/object/bitstring_value.h @@ -1,3 +1,147 @@ +/** + * @file + * @author Steve Karg + * @date June 2024 + * @brief The BitString Value object is an object with a present-value that + * uses a BACnetBitString data type. + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_BITSTRING_VALUE_H +#define BACNET_BASIC_OBJECT_BITSTRING_VALUE_H + +#include +#include +/* BACnet Stack defines - first */ +#include "bacnet/bacdef.h" +/* BACnet Stack API */ +#include "bacnet/bacerror.h" +#include "bacnet/cov.h" +#include "bacnet/rp.h" +#include "bacnet/wp.h" + +/** + * @brief Callback for gateway write present value request + * @param object_instance - object-instance number of the object + * @param old_value - BIT STRING value prior to write + * @param value - BIT STRING value of the write + */ +typedef void (*bitstring_value_write_present_value_callback)( + uint32_t object_instance, + BACNET_BIT_STRING *old_value, + BACNET_BIT_STRING *value); + +#ifdef __cplusplus +extern "C" { +#endif /* __cplusplus */ + BACNET_STACK_EXPORT + void BitString_Value_Write_Present_Value_Callback_Set( + bitstring_value_write_present_value_callback cb); + + BACNET_STACK_EXPORT + void BitString_Value_Property_Lists( + const int **pRequired, + const int **pOptional, + const int **pProprietary); + + BACNET_STACK_EXPORT + bool BitString_Value_Valid_Instance( + uint32_t object_instance); + BACNET_STACK_EXPORT + unsigned BitString_Value_Count( + void); + BACNET_STACK_EXPORT + uint32_t BitString_Value_Index_To_Instance( + unsigned index); + BACNET_STACK_EXPORT + unsigned BitString_Value_Instance_To_Index( + uint32_t instance); + + BACNET_STACK_EXPORT + int BitString_Value_Read_Property( + BACNET_READ_PROPERTY_DATA * rpdata); + + BACNET_STACK_EXPORT + bool BitString_Value_Write_Property( + BACNET_WRITE_PROPERTY_DATA * wp_data); + + /* optional API */ + BACNET_STACK_EXPORT + bool BitString_Value_Object_Instance_Add( + uint32_t instance); + + BACNET_STACK_EXPORT + bool BitString_Value_Object_Name( + uint32_t object_instance, + BACNET_CHARACTER_STRING * object_name); + BACNET_STACK_EXPORT + bool BitString_Value_Name_Set( + uint32_t object_instance, + char *new_name); + + BACNET_STACK_EXPORT + bool BitString_Value_Present_Value( + uint32_t object_instance, + BACNET_BIT_STRING * value); + BACNET_STACK_EXPORT + bool BitString_Value_Present_Value_Set( + uint32_t object_instance, + BACNET_BIT_STRING * value); + + BACNET_STACK_EXPORT + char *BitString_Value_Description( + uint32_t instance); + BACNET_STACK_EXPORT + bool BitString_Value_Description_Set( + uint32_t object_instance, + char *text_string); + + BACNET_STACK_EXPORT + bool BitString_Value_Out_Of_Service( + uint32_t object_instance); + BACNET_STACK_EXPORT + void BitString_Value_Out_Of_Service_Set( + uint32_t object_instance, bool value); + + BACNET_STACK_EXPORT + BACNET_RELIABILITY BitString_Value_Reliablity( + uint32_t object_instance); + BACNET_STACK_EXPORT + bool BitString_Value_Reliablity_Set( + uint32_t object_instance, BACNET_RELIABILITY value); + + BACNET_STACK_EXPORT + bool BitString_Value_Change_Of_Value( + uint32_t instance); + BACNET_STACK_EXPORT + void BitString_Value_Change_Of_Value_Clear( + uint32_t instance); + BACNET_STACK_EXPORT + bool BitString_Value_Encode_Value_List( + uint32_t object_instance, + BACNET_PROPERTY_VALUE * value_list); + + BACNET_STACK_EXPORT + bool BitString_Value_Write_Enabled(uint32_t instance); + BACNET_STACK_EXPORT + void BitString_Value_Write_Enable(uint32_t instance); + BACNET_STACK_EXPORT + void BitString_Value_Write_Disable(uint32_t instance); + + BACNET_STACK_EXPORT + uint32_t BitString_Value_Create(uint32_t object_instance); + BACNET_STACK_EXPORT + bool BitString_Value_Delete(uint32_t object_instance); + BACNET_STACK_EXPORT + void BitString_Value_Cleanup(void); + + BACNET_STACK_EXPORT + void BitString_Value_Init( + void); + +#ifdef __cplusplus +} +#endif /* __cplusplus */ +#endif /** * @file * @author Steve Karg diff --git a/src/bacnet/basic/object/blo.c b/src/bacnet/basic/object/blo.c index 415afafe..9497ccb0 100644 --- a/src/bacnet/basic/object/blo.c +++ b/src/bacnet/basic/object/blo.c @@ -1,10 +1,9 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2023 - * @brief Binary Lighting Output object - * - * SPDX-License-Identifier: MIT + * @brief A basic BACnet Binary Lighting Output object implementation. + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/blo.h b/src/bacnet/basic/object/blo.h index 5f74ed72..3f869733 100644 --- a/src/bacnet/basic/object/blo.h +++ b/src/bacnet/basic/object/blo.h @@ -1,14 +1,12 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2023 - * @brief Binary Lighting Output object - * - * SPDX-License-Identifier: MIT + * @brief API for a basic BACnet Binary Lighting Output object implementation. + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BINARY_LIGHTING_OUTPUT_H -#define BINARY_LIGHTING_OUTPUT_H - +#ifndef BACNET_BASIC_OBJECT_BINARY_LIGHTING_OUTPUT_H +#define BACNET_BASIC_OBJECT_BINARY_LIGHTING_OUTPUT_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/bo.c b/src/bacnet/basic/object/bo.c index 0ba191d0..0c3516c5 100644 --- a/src/bacnet/basic/object/bo.c +++ b/src/bacnet/basic/object/bo.c @@ -1,34 +1,12 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2005 - * @brief Binary Output objects, customize for your use - * - * @section DESCRIPTION - * - * The Binary Output object is a command object, and the present-value - * property uses a priority array and an enumerated 2-state data type. - * - * @section LICENSE - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * @brief A basic BACnet Binary Output object implementation. + * The Binary Lighting Output object is a commandable object, and the + * present-value property uses a priority array and an enumerated 2-state + * data type. + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/bo.h b/src/bacnet/basic/object/bo.h index a7bd0529..d47ce5b7 100644 --- a/src/bacnet/basic/object/bo.h +++ b/src/bacnet/basic/object/bo.h @@ -1,38 +1,14 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2005 - * @brief Binary Output objects, customize for your use - * - * @section DESCRIPTION - * - * The Binary Output object is a command object, and the present-value + * @brief API for a basic BACnet Binary Output object implementation. + * The Binary Output object is a commandable object, and the present-value * property uses a priority array and an enumerated 2-state data type. - * - * @section LICENSE - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BACNET_BINARY_OUTPUT_H -#define BACNET_BINARY_OUTPUT_H - +#ifndef BACNET_BASIC_OBJECT_BINARY_OUTPUT_H +#define BACNET_BASIC_OBJECT_BINARY_OUTPUT_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/bv.c b/src/bacnet/basic/object/bv.c index 71fe20cf..12f92e28 100644 --- a/src/bacnet/basic/object/bv.c +++ b/src/bacnet/basic/object/bv.c @@ -1,12 +1,11 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2006 - * @brief Binary Value object is an input object with a present-value that + * @brief A basic BACnet Binary Value object implementation. + * Binary Value objects are I/O objects with a present-value that * uses an enumerated two state active/inactive data type. - * @section LICENSE - * Copyright (C) 2006 Steve Karg - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/bv.h b/src/bacnet/basic/object/bv.h index 64df5f74..b4966340 100644 --- a/src/bacnet/basic/object/bv.h +++ b/src/bacnet/basic/object/bv.h @@ -1,15 +1,14 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2006 - * @brief Binary Value object is an input object with a present-value that + * @brief API for a basic BACnet Binary Value object implementation. + * Binary Value objects are input objects with a present-value that * uses an enumerated two state active/inactive data type. - * @section LICENSE - * Copyright (C) 2006 Steve Karg - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BACNET_BINARY_VALUE_OBJECT_H -#define BACNET_BINARY_VALUE_OBJECT_H +#ifndef BACNET_BASIC_OBJECT_BINARY_VALUE_H +#define BACNET_BASIC_OBJECT_BINARY_VALUE_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/calendar.c b/src/bacnet/basic/object/calendar.c index e6ca3f85..c3c37c51 100644 --- a/src/bacnet/basic/object/calendar.c +++ b/src/bacnet/basic/object/calendar.c @@ -3,17 +3,10 @@ * @author Steve Karg * @author Mikhail Antropov * @date June 2022 - * @brief Calendar objects, customize for your use - * - * @section DESCRIPTION - * - * The Calendar object is an object with a present-value that - * uses a BOOLEAN data type, and features a Date_List - * that is a BACnetLIST of BACnetCalendarEntry. - * - * @section LICENSE - * - * SPDX-License-Identifier: MIT + * @brief The Calendar object is an object with a present-value that + * uses a BOOLEAN data type, and features a Date_List that is a + * BACnetLIST of BACnetCalendarEntry. + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/calendar.h b/src/bacnet/basic/object/calendar.h index 090a3a16..c669b3b6 100644 --- a/src/bacnet/basic/object/calendar.h +++ b/src/bacnet/basic/object/calendar.h @@ -3,12 +3,10 @@ * @author Mikhail Antropov * @date June 2022 * @brief API for a Calendar object used by a BACnet device object - * @section LICENSE - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BACNET_CALENDAR_OBJECT_H -#define BACNET_CALENDAR_OBJECT_H +#ifndef BACNET_BASIC_OBJECT_CALENDAR_H +#define BACNET_BASIC_OBJECT_CALENDAR_H #include #include diff --git a/src/bacnet/basic/object/channel.c b/src/bacnet/basic/object/channel.c index dd842937..96e48411 100644 --- a/src/bacnet/basic/object/channel.c +++ b/src/bacnet/basic/object/channel.c @@ -1,35 +1,10 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2013 - * @brief Channel objects, customize for your use - * - * @section DESCRIPTION - * - * The Channel object is a command object without a priority array, and the - * present-value property uses a priority array and a single precision floating - * point data type. - * - * @section LICENSE - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * @brief The Channel object is a command object without a priority array, + * and the present-value property proxies an ANY data type (sort of) + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/channel.h b/src/bacnet/basic/object/channel.h index d4bcb4d3..09b6947d 100644 --- a/src/bacnet/basic/object/channel.h +++ b/src/bacnet/basic/object/channel.h @@ -1,39 +1,13 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2013 - * @brief Channel objects, customize for your use - * - * @section DESCRIPTION - * - * The Channel object is a command object without a priority array, and the - * present-value property uses a priority array and a single precision floating - * point data type. - * - * @section LICENSE - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * @brief The Channel object is a command object without a priority array, + * and the present-value property proxies an ANY data type (sort of) + * @copyright SPDX-License-Identifier: MIT */ -#ifndef CHANNEL_H -#define CHANNEL_H - +#ifndef BACNET_BASIC_OBJECT_CHANNEL_H +#define BACNET_BASIC_OBJECT_CHANNEL_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/client/device-client.c b/src/bacnet/basic/object/client/device-client.c index 58b1e2e4..4518ca91 100644 --- a/src/bacnet/basic/object/client/device-client.c +++ b/src/bacnet/basic/object/client/device-client.c @@ -1,33 +1,13 @@ -/************************************************************************** - * - * Copyright (C) 2011 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/** @file device-client.c Lightweight base "class" for handling all +/** + * @file + * @brief Lightweight base "class" for handling all * BACnet objects belonging to a BACnet device, as well as * Device-specific properties. This Device instance is designed to - * meet minimal functionality for simple clients. */ - + * meet minimal functionality for simple clients. + * @author Steve Karg + * @date 2007 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/object/color_object.c b/src/bacnet/basic/object/color_object.c index e16d5543..fd47ce65 100644 --- a/src/bacnet/basic/object/color_object.c +++ b/src/bacnet/basic/object/color_object.c @@ -1,21 +1,11 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date June 2022 - * @brief Color objects, customize for your use - * - * @section DESCRIPTION - * - * The Color object is an object with a present-value that + * @brief The Color object is an object with a present-value that * uses an x,y color single precision floating point data type. - * - * @section LICENSE - * - * Copyright (C) 2022 Steve Karg - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ - #include #include #include diff --git a/src/bacnet/basic/object/color_object.h b/src/bacnet/basic/object/color_object.h index 943f8477..0e450941 100644 --- a/src/bacnet/basic/object/color_object.h +++ b/src/bacnet/basic/object/color_object.h @@ -1,22 +1,13 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date June 2022 - * @brief Color object, customize for your use - * - * @section DESCRIPTION - * - * The Color object is an object with a present-value that + * @brief The Color object is an object with a present-value that * uses an x,y color single precision floating point data type. - * - * @section LICENSE - * - * Copyright (C) 2022 Steve Karg - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BACNET_COLOR_OBJECT_H -#define BACNET_COLOR_OBJECT_H +#ifndef BACNET_BASIC_OBJECT_COLOR_H +#define BACNET_BASIC_OBJECT_COLOR_H #include #include diff --git a/src/bacnet/basic/object/color_temperature.c b/src/bacnet/basic/object/color_temperature.c index 6bbe354e..cab78b19 100644 --- a/src/bacnet/basic/object/color_temperature.c +++ b/src/bacnet/basic/object/color_temperature.c @@ -1,21 +1,11 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date July 2022 - * @brief Color Temperature object, customize for your use - * - * @section DESCRIPTION - * - * The Color Temperature object is an object with a present-value that + * @brief The Color Temperature object is an object with a present-value that * uses an Color Temperature INTEGER type - * - * @section LICENSE - * - * Copyright (C) 2022 Steve Karg - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ - #include #include #include diff --git a/src/bacnet/basic/object/color_temperature.h b/src/bacnet/basic/object/color_temperature.h index 8c7f8885..77508feb 100644 --- a/src/bacnet/basic/object/color_temperature.h +++ b/src/bacnet/basic/object/color_temperature.h @@ -1,23 +1,12 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date July 2022 - * @brief Color Temperature object, customize for your use - * - * @section DESCRIPTION - * - * The Color Temperature object is an object with a present-value that - * uses an Color Temperature INTEGER type - * - * @section LICENSE - * - * Copyright (C) 2022 Steve Karg - * - * SPDX-License-Identifier: MIT + * @brief API for a basic Color Temperature object + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BACNET_COLOR_TEMPERATURE_H -#define BACNET_COLOR_TEMPERATURE_H - +#ifndef BACNET_BASIC_OBJECT_COLOR_TEMPERATURE_H +#define BACNET_BASIC_OBJECT_COLOR_TEMPERATURE_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/command.c b/src/bacnet/basic/object/command.c index bb2b66fa..dbeb6e35 100644 --- a/src/bacnet/basic/object/command.c +++ b/src/bacnet/basic/object/command.c @@ -1,12 +1,9 @@ /** * @file - * @author Nikola Jelic + * @author Nikola Jelic * @date 2014 * @brief Command objects, customize for your use - * - * @section DESCRIPTION - * - * The Command object type defines a standardized object whose + * @details The Command object type defines a standardized object whose * properties represent the externally visible characteristics of a * multi-action command procedure. A Command object is used to * write a set of values to a group of object properties, based on @@ -15,29 +12,7 @@ * Command object is written to, it triggers the Command object * to take a set of actions that change the values of a set of other * objects' properties. - * - * @section LICENSE - * - * Copyright (C) 2014 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * @copyright SPDX-License-Identifier: MIT */ #include #include @@ -56,17 +31,21 @@ /* me!*/ #include "bacnet/basic/object/command.h" -/*BACnetActionCommand ::= SEQUENCE { -deviceIdentifier [0] BACnetObjectIdentifier OPTIONAL, -objectIdentifier [1] BACnetObjectIdentifier, -propertyIdentifier [2] BACnetPropertyIdentifier, -propertyArrayIndex [3] Unsigned OPTIONAL, --used only with array datatype -propertyValue [4] ABSTRACT-SYNTAX.&Type, -priority [5] Unsigned (1..16) OPTIONAL, --used only when property is commandable -postDelay [6] Unsigned OPTIONAL, -quitOnFailure [7] BOOLEAN, -writeSuccessful [8] BOOLEAN -}*/ +/* + BACnetActionCommand ::= SEQUENCE { + deviceIdentifier [0] BACnetObjectIdentifier OPTIONAL, + objectIdentifier [1] BACnetObjectIdentifier, + propertyIdentifier [2] BACnetPropertyIdentifier, + propertyArrayIndex [3] Unsigned OPTIONAL, + --used only with array datatype + propertyValue [4] ABSTRACT-SYNTAX.&Type, + priority [5] Unsigned (1..16) OPTIONAL, + --used only when property is commandable + postDelay [6] Unsigned OPTIONAL, + quitOnFailure [7] BOOLEAN, + writeSuccessful [8] BOOLEAN + } +*/ int cl_encode_apdu(uint8_t *apdu, BACNET_ACTION_LIST *bcl) { diff --git a/src/bacnet/basic/object/command.h b/src/bacnet/basic/object/command.h index 3268dcc1..190dc64c 100644 --- a/src/bacnet/basic/object/command.h +++ b/src/bacnet/basic/object/command.h @@ -1,47 +1,12 @@ /** * @file - * @author Nikola Jelic + * @author Nikola Jelic * @date 2014 - * @brief Command objects, customize for your use - * - * @section DESCRIPTION - * - * The Command object type defines a standardized object whose - * properties represent the externally visible characteristics of a - * multi-action command procedure. A Command object is used to - * write a set of values to a group of object properties, based on - * the "action code" that is written to the Present_Value of the - * Command object. Whenever the Present_Value property of the - * Command object is written to, it triggers the Command object - * to take a set of actions that change the values of a set of other - * objects' properties. - * - * @section LICENSE - * - * Copyright (C) 2014 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * @brief API for basic Command objects, customize for your use + * @copyright SPDX-License-Identifier: MIT */ -#ifndef COMMAND_H -#define COMMAND_H - +#ifndef BACNET_BASIC_OBJECT_COMMAND_H +#define BACNET_BASIC_OBJECT_COMMAND_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/credential_data_input.c b/src/bacnet/basic/object/credential_data_input.c index 67fa4e57..ee4b8ca7 100644 --- a/src/bacnet/basic/object/credential_data_input.c +++ b/src/bacnet/basic/object/credential_data_input.c @@ -1,30 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2015 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* Credential Data Input Objects - customize for your use */ - +/** + * @file + * @author Nikola Jelic + * @date 2015 + * @brief Credential Data Input Objects - customize for your use + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/object/credential_data_input.h b/src/bacnet/basic/object/credential_data_input.h index 71236da0..0225b8e1 100644 --- a/src/bacnet/basic/object/credential_data_input.h +++ b/src/bacnet/basic/object/credential_data_input.h @@ -1,30 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2015 Nikola Jelic -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef CREDENTIAL_DATA_INPUT_H -#define CREDENTIAL_DATA_INPUT_H - +/** + * @file + * @author Nikola Jelic + * @date 2015 + * @brief Credential Data Input Objects - customize for your use + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_CREDENTIAL_DATA_INPUT_H +#define BACNET_BASIC_OBJECT_CREDENTIAL_DATA_INPUT_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/csv.c b/src/bacnet/basic/object/csv.c index 9e56a2d9..bbdeedf9 100644 --- a/src/bacnet/basic/object/csv.c +++ b/src/bacnet/basic/object/csv.c @@ -1,30 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2012 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* CharacterString Value Objects */ - +/** + * @file + * @author Steve Karg + * @date 2012 + * @brief A basic BACnet CharacterString Value object with a CharacterString + * as the datatype for the present-value property. + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/object/csv.h b/src/bacnet/basic/object/csv.h index c9f0a1fb..1fab68db 100644 --- a/src/bacnet/basic/object/csv.h +++ b/src/bacnet/basic/object/csv.h @@ -1,30 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef CSV_H -#define CSV_H - +/** + * @file + * @author Steve Karg + * @date 2012 + * @brief API for a basic BACnet CharacterString Value object + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_CHARACTER_STRING_VALUE_H +#define BACNET_BASIC_OBJECT_CHARACTER_STRING_VALUE_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/device.c b/src/bacnet/basic/object/device.c index c644f3d2..e3011c45 100644 --- a/src/bacnet/basic/object/device.c +++ b/src/bacnet/basic/object/device.c @@ -1,12 +1,10 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2005 * @brief Base "class" for handling all BACnet objects belonging * to a BACnet device, as well as Device-specific properties. - * @section LICENSE - * Copyright (C) 2005 Steve Karg - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/device.h b/src/bacnet/basic/object/device.h index 0647f011..fa91db0f 100644 --- a/src/bacnet/basic/object/device.h +++ b/src/bacnet/basic/object/device.h @@ -1,34 +1,13 @@ -/************************************************************************** -* -* Copyright (C) 2005 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ - -/** @file device.h Defines functions for handling all BACnet objects belonging - * to a BACnet device, as well as Device-specific properties. */ - -#ifndef DEVICE_H -#define DEVICE_H - +/** + * @file + * @author Steve Karg + * @date 2005 + * @brief API for handling all BACnet objects belonging to a BACnet device, + * as well as Device-specific properties. + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_DEVICE_H +#define BACNET_BASIC_OBJECT_DEVICE_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/gateway/gw_device.c b/src/bacnet/basic/object/gateway/gw_device.c index 90edc0a5..05830264 100644 --- a/src/bacnet/basic/object/gateway/gw_device.c +++ b/src/bacnet/basic/object/gateway/gw_device.c @@ -1,31 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2005,2010 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/** @file gw_device.c Functions that extend the Device object to support - * routing. */ - +/** + * @file + * @brief Functions that extend the Device object to support routing. + * @author Tom Brennan + * @author Peter Mc Shane + * @author Piotr Grudzinski + * @date October 2010 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/object/iv.c b/src/bacnet/basic/object/iv.c index e190a5fa..793e1151 100644 --- a/src/bacnet/basic/object/iv.c +++ b/src/bacnet/basic/object/iv.c @@ -1,36 +1,11 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2014 - * @brief Integer Value objects, customize for your use - * - * @section DESCRIPTION - * - * The Integer Value object is an object with a present-value that + * @brief The Integer Value object is an object with a present-value that * uses an INTEGER data type. - * - * @section LICENSE - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * @copyright SPDX-License-Identifier: MIT */ - #include #include #include diff --git a/src/bacnet/basic/object/iv.h b/src/bacnet/basic/object/iv.h index 11927435..f2b1c2d7 100644 --- a/src/bacnet/basic/object/iv.h +++ b/src/bacnet/basic/object/iv.h @@ -1,38 +1,12 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2014 - * @brief Integer Value objects, customize for your use - * - * @section DESCRIPTION - * - * The Integer Value object is an object with a present-value that - * uses an INTEGER data type. - * - * @section LICENSE - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * @brief API for Integer Value objects + * @copyright SPDX-License-Identifier: MIT */ -#ifndef IV_H -#define IV_H - +#ifndef BACNET_BASIC_OBJECT_INTEGER_VALUE_H +#define BACNET_BASIC_OBJECT_INTEGER_VALUE_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/lc.c b/src/bacnet/basic/object/lc.c index c50b9b23..242ea593 100644 --- a/src/bacnet/basic/object/lc.c +++ b/src/bacnet/basic/object/lc.c @@ -1,31 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2007 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* Load Control Objects - customize for your use */ -/* from 135-2004-Addendum e */ - +/** + * @file + * @author Steve Karg + * @date 2007 + * @brief The Load Control Objects from 135-2004-Addendum e + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/object/lc.h b/src/bacnet/basic/object/lc.h index 331d49c3..150f73da 100644 --- a/src/bacnet/basic/object/lc.h +++ b/src/bacnet/basic/object/lc.h @@ -1,30 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2007 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef LOADCONTROL_H -#define LOADCONTROL_H - +/** + * @file + * @author Steve Karg + * @date 2007 + * @brief The Load Control Objects from 135-2004-Addendum e + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_LOAD_CONTROL_H +#define BACNET_BASIC_OBJECT_LOAD_CONTROL_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/lo.c b/src/bacnet/basic/object/lo.c index 311253b4..ae37236e 100644 --- a/src/bacnet/basic/object/lo.c +++ b/src/bacnet/basic/object/lo.c @@ -1,32 +1,10 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2013 - * @brief Lighting Output object - * - * @section LICENSE - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * + * @brief A basic BACnet Lighting Output object implementation + * @copyright SPDX-License-Identifier: MIT */ - #include #include #include diff --git a/src/bacnet/basic/object/lo.h b/src/bacnet/basic/object/lo.h index 359f9fe0..c1199afa 100644 --- a/src/bacnet/basic/object/lo.h +++ b/src/bacnet/basic/object/lo.h @@ -1,30 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2007 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef LIGHTING_OUTPUT_H -#define LIGHTING_OUTPUT_H - +/** + * @file + * @author Steve Karg + * @date 2007 + * @brief API for a basic Lighting Output object + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_LIGHTING_OUTPUT_H +#define BACNET_BASIC_OBJECT_LIGHTING_OUTPUT_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/lsp.c b/src/bacnet/basic/object/lsp.c index df7a9b42..890b2be1 100644 --- a/src/bacnet/basic/object/lsp.c +++ b/src/bacnet/basic/object/lsp.c @@ -1,30 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2005 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* Life Safety Point Objects - customize for your use */ - +/** + * @file + * @author Steve Karg + * @date 2005 + * @brief A basic BACnet Life Safety Point object implementation. + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/object/lsp.h b/src/bacnet/basic/object/lsp.h index 71e8205a..d41c3ffd 100644 --- a/src/bacnet/basic/object/lsp.h +++ b/src/bacnet/basic/object/lsp.h @@ -1,30 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2005 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef LSP_H -#define LSP_H - +/** + * @file + * @author Steve Karg + * @date 2005 + * @brief API for basic Life Safety Point objects + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_LIFE_SAFETY_POINT_H +#define BACNET_BASIC_OBJECT_LIFE_SAFETY_POINT_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/lsz.c b/src/bacnet/basic/object/lsz.c index b07d2d31..02fc11f7 100644 --- a/src/bacnet/basic/object/lsz.c +++ b/src/bacnet/basic/object/lsz.c @@ -1,21 +1,15 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date March 2024 - * @brief Example of a Life Safety Zone object type - * - * The Life Safety Zone object type defines a standardized object + * @brief A basic BACnet Life Safety Zone object type implementation. + * @details The Life Safety Zone object type defines a standardized object * whose properties represent the externally visible characteristics * associated with an arbitrary group of BACnet Life Safety Point * and Life Safety Zone objects in fire, life safety and security * applications. The condition of a Life Safety Zone object is * represented by a mode and a state. - * - * @copyright - * - * Copyright (C) 2024 Steve Karg - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/lsz.h b/src/bacnet/basic/object/lsz.h index 499c5c5e..bad85e58 100644 --- a/src/bacnet/basic/object/lsz.h +++ b/src/bacnet/basic/object/lsz.h @@ -1,25 +1,12 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date March 2024 - * @brief Example API for Life Safety Zone Object - * - * The Life Safety Zone object type defines a standardized object - * whose properties represent the externally visible characteristics - * associated with an arbitrary group of BACnet Life Safety Point - * and Life Safety Zone objects in fire, life safety and security - * applications. The condition of a Life Safety Zone object is - * represented by a mode and a state. - * - * @copyright - * - * Copyright (C) 2024 Steve Karg - * - * SPDX-License-Identifier: MIT + * @brief API for a basic BACnet Life Safety Zone object type implementation. + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BACNET_LIFE_SAFETY_ZONE_H -#define BACNET_LIFE_SAFETY_ZONE_H - +#ifndef BACNET_BASIC_OBJECT_LIFE_SAFETY_ZONE_H +#define BACNET_BASIC_OBJECT_LIFE_SAFETY_ZONE_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/ms-input.c b/src/bacnet/basic/object/ms-input.c index 91565006..b2152135 100644 --- a/src/bacnet/basic/object/ms-input.c +++ b/src/bacnet/basic/object/ms-input.c @@ -1,12 +1,10 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2009 * @brief Multi-State object is an input object with a present-value that * uses an integer data type with a sequence of 1 to N values. - * @section LICENSE - * Copyright (C) 2009 Steve Karg - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/ms-input.h b/src/bacnet/basic/object/ms-input.h index 9ac847f0..b75934ee 100644 --- a/src/bacnet/basic/object/ms-input.h +++ b/src/bacnet/basic/object/ms-input.h @@ -1,16 +1,13 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2009 * @brief Multi-State object is an input object with a present-value that * uses an integer data type with a sequence of 1 to N values. - * @section LICENSE - * Copyright (C) 2009 Steve Karg - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BACNET_MULTI_STATE_INPUT_H -#define BACNET_MULTI_STATE_INPUT_H - +#ifndef BACNET_BASIC_OBJECT_MULTI_STATE_INPUT_H +#define BACNET_BASIC_OBJECT_MULTI_STATE_INPUT_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/mso.c b/src/bacnet/basic/object/mso.c index ba30bb9e..3a4a7f76 100644 --- a/src/bacnet/basic/object/mso.c +++ b/src/bacnet/basic/object/mso.c @@ -1,34 +1,10 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2005 - * @brief Multi-State Output objects, customize for your use - * - * @section DESCRIPTION - * - * The Multi-State object is an object with a present-value that + * @brief The Multi-State object is an object with a present-value that * uses an integer data type with a sequence of 1 to N values. - * - * @section LICENSE - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/mso.h b/src/bacnet/basic/object/mso.h index c1890e81..58751ce6 100644 --- a/src/bacnet/basic/object/mso.h +++ b/src/bacnet/basic/object/mso.h @@ -1,37 +1,12 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2005 - * @brief Multi-State Output objects, customize for your use - * - * @section DESCRIPTION - * - * The Multi-State object is an object with a present-value that - * uses an integer data type with a sequence of 1 to N values. - * - * @section LICENSE - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * @brief API for basic Multi-State Output objects + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BACNET_MULTISTATE_OUTPUT_H -#define BACNET_MULTISTATE_OUTPUT_H +#ifndef BACNET_BASIC_OBJECT_MULTI_STATE_OUTPUT_H +#define BACNET_BASIC_OBJECT_MULTI_STATE_OUTPUT_H #include #include diff --git a/src/bacnet/basic/object/msv.c b/src/bacnet/basic/object/msv.c index 46133f0f..eb514e02 100644 --- a/src/bacnet/basic/object/msv.c +++ b/src/bacnet/basic/object/msv.c @@ -1,12 +1,10 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2009 - * @brief Multi-State object is an input object with a present-value that + * @brief Multi-State object is an object with a present-value that * uses an integer data type with a sequence of 1 to N values. - * @section LICENSE - * Copyright (C) 2009 Steve Karg - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/msv.h b/src/bacnet/basic/object/msv.h index 05590b7f..bd1d6e8e 100644 --- a/src/bacnet/basic/object/msv.h +++ b/src/bacnet/basic/object/msv.h @@ -1,16 +1,13 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2009 - * @brief Multi-State object is an input object with a present-value that + * @brief Multi-State object is an object with a present-value that * uses an integer data type with a sequence of 1 to N values. - * @section LICENSE - * Copyright (C) 2009 Steve Karg - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BACNET_MULTI_STATE_VALUE_H -#define BACNET_MULTI_STATE_VALUE_H - +#ifndef BACNET_BASIC_OBJECT_MULTI_STATE_VALUE_H +#define BACNET_BASIC_OBJECT_MULTI_STATE_VALUE_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/nc.c b/src/bacnet/basic/object/nc.c index 7e11c132..14ff3145 100644 --- a/src/bacnet/basic/object/nc.c +++ b/src/bacnet/basic/object/nc.c @@ -1,33 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2011 Krzysztof Malorny - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - * Additional changes, Copyright (c) 2018 Ed Hague - * - * 2018.06.17 - Attempting to write to Object_Name returned - *UNKNOWN_PROPERTY. Now returns WRITE_ACCESS_DENIED - * - *********************************************************************/ - +/** + * @file + * @author Krzysztof Malorny + * @author Ed Hague + * @date 2011, 2018 + * @brief A basic BACnet Notification Class object + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/object/nc.h b/src/bacnet/basic/object/nc.h index 7b321d42..687acca5 100644 --- a/src/bacnet/basic/object/nc.h +++ b/src/bacnet/basic/object/nc.h @@ -1,29 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2011 Krzysztof Malorny - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ -#ifndef NC_H -#define NC_H +/** + * @file + * @author Krzysztof Malorny + * @date 2011 + * @brief API for a basic BACnet Notification Class object + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_NOTIFICATION_CLASS_H +#define BACNET_BASIC_OBJECT_NOTIFICATION_CLASS_H /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" /* BACnet Stack API */ diff --git a/src/bacnet/basic/object/netport.c b/src/bacnet/basic/object/netport.c index d1d4a5a0..753acfea 100644 --- a/src/bacnet/basic/object/netport.c +++ b/src/bacnet/basic/object/netport.c @@ -1,34 +1,10 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2016 - * @brief Network port objects, customize for your use - * - * @section DESCRIPTION - * - * The Network Port object provides access to the configuration - * and properties of network ports of a device. - * - * @section LICENSE - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * @brief A basic BACnet Network Port object provides access to the + * configuration and properties of any network ports of a device. + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/netport.h b/src/bacnet/basic/object/netport.h index f6113e53..4397e1ca 100644 --- a/src/bacnet/basic/object/netport.h +++ b/src/bacnet/basic/object/netport.h @@ -1,39 +1,12 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2016 - * @brief Network port objects, customize for your use - * - * @section DESCRIPTION - * - * The Network Port object provides access to the configuration - * and properties of network ports of a device. - * - * @section LICENSE - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + * @brief API for basic BACnet Network port object + * @copyright SPDX-License-Identifier: MIT */ - -#ifndef NETPORT_H -#define NETPORT_H - +#ifndef BACNET_BASIC_OBJECT_NETPORT_H +#define BACNET_BASIC_OBJECT_NETPORT_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/objects.c b/src/bacnet/basic/object/objects.c index 772ea6c1..204ebdc4 100644 --- a/src/bacnet/basic/object/objects.c +++ b/src/bacnet/basic/object/objects.c @@ -1,37 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2008 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ - +/** + * @file + * @author Steve Karg + * @date 2008 + * @brief A basic BACnet device object list management implementation + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include #include @@ -40,8 +13,6 @@ #include "bacnet/basic/sys/keylist.h" #include "bacnet/basic/object/objects.h" -/** @file objects.c Manage Device Objects. */ - /* list of devices */ static OS_Keylist Device_List = NULL; diff --git a/src/bacnet/basic/object/objects.h b/src/bacnet/basic/object/objects.h index 32c3a335..1c60b5c9 100644 --- a/src/bacnet/basic/object/objects.h +++ b/src/bacnet/basic/object/objects.h @@ -1,29 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef BACNET_OBJECTS_H -#define BACNET_OBJECTS_H - +/** + * @file + * @author Steve Karg + * @date 2012 + * @brief API for basic BACnet device object list management implementation + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_OBJECTS_H +#define BACNET_BASIC_OBJECT_OBJECTS_H #include #include #include diff --git a/src/bacnet/basic/object/osv.c b/src/bacnet/basic/object/osv.c index f9ab3dbb..6897e4fd 100644 --- a/src/bacnet/basic/object/osv.c +++ b/src/bacnet/basic/object/osv.c @@ -1,30 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2015 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* OctetString Value Objects - customize for your use */ - +/** + * @file + * @author Nikola Jelic + * @date 2015 + * @brief A basic BACnet OctetString Value object implementation. + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/object/osv.h b/src/bacnet/basic/object/osv.h index 4473f0cd..507ddaef 100644 --- a/src/bacnet/basic/object/osv.h +++ b/src/bacnet/basic/object/osv.h @@ -1,30 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2015 Nikola Jelic -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef OSV_H -#define OSV_H - +/** + * @file + * @author Nikola Jelic + * @date 2015 + * @brief API for a basic BACnet OctetString Value object implementation. + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_OCTET_STRING_VALUE_H +#define BACNET_BASIC_OBJECT_OCTET_STRING_VALUE_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/piv.c b/src/bacnet/basic/object/piv.c index b49bb0ab..98fba6e1 100644 --- a/src/bacnet/basic/object/piv.c +++ b/src/bacnet/basic/object/piv.c @@ -1,30 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2015 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* Positiveinteger Value Objects - customize for your use */ - +/** + * @file + * @author Nikola Jelic + * @date 2015 + * @brief API for a basic BACnet Positive Integer Value object implementation. + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/object/piv.h b/src/bacnet/basic/object/piv.h index a1090095..ebd7a67c 100644 --- a/src/bacnet/basic/object/piv.h +++ b/src/bacnet/basic/object/piv.h @@ -1,30 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2015 Nikola Jelic -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef PIV_H -#define PIV_H - +/** + * @file + * @author Nikola Jelic + * @date 2015 + * @brief API for a basic BACnet Positive Integer Value object implementation. + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_POSITIVE_INTEGER_VALUE_H +#define BACNET_BASIC_OBJECT_POSITIVE_INTEGER_VALUE_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/schedule.c b/src/bacnet/basic/object/schedule.c index 65dae7cb..aec49801 100644 --- a/src/bacnet/basic/object/schedule.c +++ b/src/bacnet/basic/object/schedule.c @@ -1,28 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2015 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - +/** + * @file + * @author Nikola Jelic + * @date 2015 + * @brief A basic BACnet Schedule object implementation. + * @copyright SPDX-License-Identifier: MIT + */ #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/schedule.h b/src/bacnet/basic/object/schedule.h index 60abe3b3..1320a05f 100644 --- a/src/bacnet/basic/object/schedule.h +++ b/src/bacnet/basic/object/schedule.h @@ -1,31 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2015 Nikola Jelic -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ - -#ifndef SCHEDULE_H -#define SCHEDULE_H - +/** + * @file + * @author Nikola Jelic + * @date 2015 + * @brief API for a basic BACnet Schedule object implementation. + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_SCHEDULE_H +#define BACNET_BASIC_OBJECT_SCHEDULE_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/structured_view.c b/src/bacnet/basic/object/structured_view.c index a3eadcff..4fe7a680 100644 --- a/src/bacnet/basic/object/structured_view.c +++ b/src/bacnet/basic/object/structured_view.c @@ -6,10 +6,7 @@ * to hold references to subordinate objects, which may include other * Structured View objects, thereby allowing multilevel hierarchies * to be created. - * - * @section LICENSE - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/structured_view.h b/src/bacnet/basic/object/structured_view.h index 8b48c53d..2de73846 100644 --- a/src/bacnet/basic/object/structured_view.h +++ b/src/bacnet/basic/object/structured_view.h @@ -3,13 +3,10 @@ * @author Steve Karg * @date May 2024 * @brief API for a Structured View object used by a BACnet device object - * @section LICENSE - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BACNET_STRUCTURED_VIEW_OBJECT_H -#define BACNET_STRUCTURED_VIEW_OBJECT_H - +#ifndef BACNET_BASIC_STRUCTURED_VIEW_OBJECT_H +#define BACNET_BASIC_STRUCTURED_VIEW_OBJECT_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/object/time_value.c b/src/bacnet/basic/object/time_value.c index 696200ce..bdc50481 100644 --- a/src/bacnet/basic/object/time_value.c +++ b/src/bacnet/basic/object/time_value.c @@ -5,10 +5,7 @@ * @date June 2023 * @brief Time Value object is an object with a present-value that * uses an bacnet time data type. - * - * @section LICENSE - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/object/time_value.h b/src/bacnet/basic/object/time_value.h index 956e5869..d14c02a2 100644 --- a/src/bacnet/basic/object/time_value.h +++ b/src/bacnet/basic/object/time_value.h @@ -3,12 +3,10 @@ * @author Mikhail Antropov * @date June 2023 * @brief API for a Time Value object used by a BACnet device object - * @section LICENSE - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ -#ifndef BACNET_TIME_VALUE_OBJECT_H -#define BACNET_TIME_VALUE_OBJECT_H +#ifndef BACNET_BASIC_TIME_VALUE_OBJECT_H +#define BACNET_BASIC_TIME_VALUE_OBJECT_H #include #include diff --git a/src/bacnet/basic/object/trendlog.c b/src/bacnet/basic/object/trendlog.c index 6ee01f90..a2a40a57 100644 --- a/src/bacnet/basic/object/trendlog.c +++ b/src/bacnet/basic/object/trendlog.c @@ -1,28 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2009 Peter Mc Shane - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - +/** + * @file + * @author Peter Mc Shane + * @date 2009 + * @brief A basic Trend Log object implementation. + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/object/trendlog.h b/src/bacnet/basic/object/trendlog.h index 67adb66a..8d68721f 100644 --- a/src/bacnet/basic/object/trendlog.h +++ b/src/bacnet/basic/object/trendlog.h @@ -1,30 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2009 Peter Mc Shane -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef TRENDLOG_H -#define TRENDLOG_H - +/** + * @file + * @author Peter Mc Shane + * @date 2009 + * @brief API for a basic Trend Log object implementation. + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_OBJECT_TRENDLOG_H +#define BACNET_BASIC_OBJECT_TRENDLOG_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/service/h_alarm_ack.c b/src/bacnet/basic/service/h_alarm_ack.c index c0ccf930..0a48bfa3 100644 --- a/src/bacnet/basic/service/h_alarm_ack.c +++ b/src/bacnet/basic/service/h_alarm_ack.c @@ -1,28 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2005 Steve Karg - * Copyright (C) 2011 Krzysztof Malorny - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief A basic AlarmAcknowledgment service Handler + * @author Steve Karg + * @author Krzysztof Malorny + * @author John Minack + * @date 2005, 2011 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/basic/service/h_alarm_ack.h b/src/bacnet/basic/service/h_alarm_ack.h index 085b3daa..3d3fa785 100644 --- a/src/bacnet/basic/service/h_alarm_ack.h +++ b/src/bacnet/basic/service/h_alarm_ack.h @@ -1,33 +1,12 @@ /** -* @file -* @author Steve Karg -* @date 2019 -* @brief Header file a basic Alarm Acknowledgment Handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef HANDLER_ALARM_ACK_H -#define HANDLER_ALARM_ACK_H - + * @file + * @brief Header file a basic Alarm Acknowledgment service Handler + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_SERVICE_ALARM_ACK_H +#define BACNET_BASIC_SERVICE_ALARM_ACK_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/service/h_apdu.c b/src/bacnet/basic/service/h_apdu.c index 8a844e7a..6dacf8bf 100644 --- a/src/bacnet/basic/service/h_apdu.c +++ b/src/bacnet/basic/service/h_apdu.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2005 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief Handles Application Protocol Data Units (APDU) for BACnet + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include #include @@ -47,8 +21,6 @@ #include "bacnet/basic/tsm/tsm.h" #include "bacnet/basic/services.h" -/** @file apdu.c Handles APDU services */ - /* APDU Timeout in Milliseconds */ static uint16_t Timeout_Milliseconds = 3000; /* Number of APDU Retries */ diff --git a/src/bacnet/basic/service/h_apdu.h b/src/bacnet/basic/service/h_apdu.h index b9731ef6..666ca4fc 100644 --- a/src/bacnet/basic/service/h_apdu.h +++ b/src/bacnet/basic/service/h_apdu.h @@ -1,33 +1,12 @@ /** -* @file -* @author Steve Karg -* @date 2019 -* @brief Header file for a basic APDU Handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef BACNET_APDU_HANDLER_H -#define BACNET_APDU_HANDLER_H - + * @file + * @brief Header file for a basic APDU Handler + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_SERVICE_APDU_HANDLER_H +#define BACNET_BASIC_SERVICE_APDU_HANDLER_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/service/h_arf.c b/src/bacnet/basic/service/h_arf.c index 625e0e53..b242366f 100644 --- a/src/bacnet/basic/service/h_arf.c +++ b/src/bacnet/basic/service/h_arf.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2005 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief Handles AtomicReadFile-Request service. + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -44,8 +27,6 @@ #include "bacnet/basic/services.h" #include "bacnet/datalink/datalink.h" -/** @file h_arf.c Handles Atomic Read File request. */ - /* from BACnet SSPC-135-2004 diff --git a/src/bacnet/basic/service/h_arf.h b/src/bacnet/basic/service/h_arf.h index 9c3eedc3..63f18f9b 100644 --- a/src/bacnet/basic/service/h_arf.h +++ b/src/bacnet/basic/service/h_arf.h @@ -1,33 +1,12 @@ /** -* @file -* @author Steve Karg -* @date October 2019 -* @brief Header file for a basic Atomic Read File request handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef HANDLER_ATOMIC_READ_FILE_H -#define HANDLER_ATOMIC_READ_FILE_H - + * @file + * @brief API for AtomicReadFile-Request service handler + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_SERVICE_HANDLER_ATOMIC_READ_FILE_H +#define BACNET_BASIC_SERVICE_HANDLER_ATOMIC_READ_FILE_H #include #include #include diff --git a/src/bacnet/basic/service/h_arf_a.c b/src/bacnet/basic/service/h_arf_a.c index edb1984d..1edeaba0 100644 --- a/src/bacnet/basic/service/h_arf_a.c +++ b/src/bacnet/basic/service/h_arf_a.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2005 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief Handles Acknowledgment of Atomic Read File response. + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: MIT + */ #include #include /* BACnet Stack defines - first */ @@ -39,8 +22,6 @@ #include "bacnet/basic/tsm/tsm.h" #include "bacnet/basic/services.h" -/** @file h_arf_a.c Handles Acknowledgment of Atomic Read File response. */ - /* We performed an AtomicReadFile Request, */ /* and here is the data from the server */ /* Note: it does not have to be the same file=instance */ diff --git a/src/bacnet/basic/service/h_arf_a.h b/src/bacnet/basic/service/h_arf_a.h index 6cc21a58..2327ce13 100644 --- a/src/bacnet/basic/service/h_arf_a.h +++ b/src/bacnet/basic/service/h_arf_a.h @@ -1,33 +1,12 @@ /** -* @file -* @author Steve Karg -* @date October 2019 -* @brief Header file for a basic Atomic Read File Ack handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef ATOMIC_READ_FILE_ACK_HANDLER_H -#define ATOMIC_READ_FILE_ACK_HANDLER_H - + * @file + * @brief Header file for a basic Atomic Read File Ack handler + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_SERVICE_ATOMIC_READ_FILE_ACK_HANDLER_H +#define BACNET_BASIC_SERVICE_ATOMIC_READ_FILE_ACK_HANDLER_H #include #include #include diff --git a/src/bacnet/basic/service/h_awf.c b/src/bacnet/basic/service/h_awf.c index da46cb22..45006b9d 100644 --- a/src/bacnet/basic/service/h_awf.c +++ b/src/bacnet/basic/service/h_awf.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2007 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief AtomicWriteFile-Request service handler + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -46,8 +29,6 @@ #include "bacnet/basic/object/bacfile.h" #endif -/** @file h_awf.c Handles Atomic Write File request. */ - /* from BACnet SSPC-135-2004 diff --git a/src/bacnet/basic/service/h_awf.h b/src/bacnet/basic/service/h_awf.h index a1b88d0d..4460bf07 100644 --- a/src/bacnet/basic/service/h_awf.h +++ b/src/bacnet/basic/service/h_awf.h @@ -1,33 +1,12 @@ /** -* @file -* @author Steve Karg -* @date October 2019 -* @brief Header file for Atomic Write File request handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef ATOMIC_WRITE_FILE_HANDLER_H -#define ATOMIC_WRITE_FILE_HANDLER_H - + * @file + * @brief API for AtomicWriteFile-Request service handler + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_SERVICE_ATOMIC_WRITE_FILE_HANDLER_H +#define BACNET_BASIC_SERVICE_ATOMIC_WRITE_FILE_HANDLER_H #include #include #include diff --git a/src/bacnet/basic/service/h_ccov.c b/src/bacnet/basic/service/h_ccov.c index 4eac8e2a..5fce99a2 100644 --- a/src/bacnet/basic/service/h_ccov.c +++ b/src/bacnet/basic/service/h_ccov.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2011 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief Confirmed COV Notifications service handler + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -42,7 +25,6 @@ #include "bacnet/datalink/datalink.h" #include "bacnet/basic/sys/debug.h" -/** @file h_ccov.c Handles Confirmed COV Notifications. */ #define PRINTF debug_perror /* max number of COV properties decoded in a COV notification */ diff --git a/src/bacnet/basic/service/h_ccov.h b/src/bacnet/basic/service/h_ccov.h index b667f3c5..02a4bd32 100644 --- a/src/bacnet/basic/service/h_ccov.h +++ b/src/bacnet/basic/service/h_ccov.h @@ -1,33 +1,12 @@ /** -* @file -* @author Steve Karg -* @date October 2019 -* @brief Header file for a basic ConfirmedCOV notification handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef HANDLER_CCOV_NOTIFICATION_H -#define HANDLER_CCOV_NOTIFICATION_H - + * @file + * @brief Header file for a basic ConfirmedCOV notification handler + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_SERVICE_HANDLER_CCOV_NOTIFICATION_H +#define BACNET_BASIC_SERVICE_HANDLER_CCOV_NOTIFICATION_H #include #include #include diff --git a/src/bacnet/basic/service/h_cov.c b/src/bacnet/basic/service/h_cov.c index a77b01ff..e6d30679 100644 --- a/src/bacnet/basic/service/h_cov.c +++ b/src/bacnet/basic/service/h_cov.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2007-2008 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief A basic SubscribeCOV request handler, state machine, & task + * @author Steve Karg + * @date 2007 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -52,8 +35,6 @@ #define MAX_COV_PROPERTIES 2 #endif -/** @file h_cov.c Handles Change of Value (COV) services. */ - typedef struct BACnet_COV_Address { bool valid : 1; BACNET_ADDRESS dest; diff --git a/src/bacnet/basic/service/h_cov.h b/src/bacnet/basic/service/h_cov.h index 6dd6a66e..8d992c0e 100644 --- a/src/bacnet/basic/service/h_cov.h +++ b/src/bacnet/basic/service/h_cov.h @@ -1,32 +1,12 @@ /** -* @file -* @author Steve Karg -* @date October 2019 -* @brief Header file for a basic SubscribeCOV request handler, FSM, & Task -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef HANDLER_COV_SUBSCRIBE_H -#define HANDLER_COV_SUBSCRIBE_H + * @file + * @brief Header file for a basic SubscribeCOV request handler, FSM, & Task + * @author Steve Karg + * @date 2007 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_SERVICE_HANDLER_COV_SUBSCRIBE_H +#define BACNET_BASIC_SERVICE_HANDLER_COV_SUBSCRIBE_H #include #include diff --git a/src/bacnet/basic/service/h_create_object.c b/src/bacnet/basic/service/h_create_object.c index 12bc3230..8b023cda 100644 --- a/src/bacnet/basic/service/h_create_object.c +++ b/src/bacnet/basic/service/h_create_object.c @@ -3,9 +3,7 @@ * @brief CreateObject service application handlers * @author Steve Karg * @date August 2023 - * @section LICENSE - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/service/h_create_object.h b/src/bacnet/basic/service/h_create_object.h index 7ebaf74c..2e3a235d 100644 --- a/src/bacnet/basic/service/h_create_object.h +++ b/src/bacnet/basic/service/h_create_object.h @@ -3,13 +3,10 @@ * @brief API for CreateObject service handlers * @author Steve Karg * @date August 2023 - * @section LICENSE - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ -#ifndef HANDLER_CREATE_OBJECT_H -#define HANDLER_CREATE_OBJECT_H - +#ifndef BACNET_BASIC_SERVICE_HANDLER_CREATE_OBJECT_H +#define BACNET_BASIC_SERVICE_HANDLER_CREATE_OBJECT_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/service/h_dcc.c b/src/bacnet/basic/service/h_dcc.c index ffc54376..e58c6985 100644 --- a/src/bacnet/basic/service/h_dcc.c +++ b/src/bacnet/basic/service/h_dcc.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief Handles Device Communication Control request. + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -41,8 +24,6 @@ #include "bacnet/basic/services.h" #include "bacnet/datalink/datalink.h" -/** @file h_dcc.c Handles Device Communication Control request. */ - static char My_Password[32] = "filister"; /** Sets (non-volatile hold) the password to be used for DCC requests. diff --git a/src/bacnet/basic/service/h_dcc.h b/src/bacnet/basic/service/h_dcc.h index a4b8dc1c..0bcfb7e0 100644 --- a/src/bacnet/basic/service/h_dcc.h +++ b/src/bacnet/basic/service/h_dcc.h @@ -1,33 +1,12 @@ /** * @file -* @author Steve Karg -* @date October 2019 * @brief Header file for a basic DeviceCommunicationControl request handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +* @author Steve Karg +* @date October 2019 +* @copyright SPDX-License-Identifier: MIT */ -#ifndef HANDLER_DEVICE_COMMUNICATION_CONTROL_H -#define HANDLER_DEVICE_COMMUNICATION_CONTROL_H - +#ifndef BACNET_BASIC_SERVICE_HANDLER_DCC_H +#define BACNET_BASIC_SERVICE_HANDLER_DCC_H #include #include #include diff --git a/src/bacnet/basic/service/h_delete_object.c b/src/bacnet/basic/service/h_delete_object.c index c05102a4..a550c2e6 100644 --- a/src/bacnet/basic/service/h_delete_object.c +++ b/src/bacnet/basic/service/h_delete_object.c @@ -3,9 +3,7 @@ * @brief DeleteObject service application handlers * @author Steve Karg * @date August 2023 - * @section LICENSE - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/service/h_delete_object.h b/src/bacnet/basic/service/h_delete_object.h index f3ec21ba..c7e8bc28 100644 --- a/src/bacnet/basic/service/h_delete_object.h +++ b/src/bacnet/basic/service/h_delete_object.h @@ -3,13 +3,10 @@ * @brief API for DeleteObject service handlers * @author Steve Karg * @date August 2023 - * @section LICENSE - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ -#ifndef HANDLER_DELETE_OBJECT_H -#define HANDLER_DELETE_OBJECT_H - +#ifndef BACNET_BASIC_SERVICE_HANDLER_DELETE_OBJECT_H +#define BACNET_BASIC_SERVICE_HANDLER_DELETE_OBJECT_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/service/h_gas_a.c b/src/bacnet/basic/service/h_gas_a.c index fb5141a5..f17678ec 100644 --- a/src/bacnet/basic/service/h_gas_a.c +++ b/src/bacnet/basic/service/h_gas_a.c @@ -1,38 +1,15 @@ /** * @file + * @brief GetAlarmSummary ACK service handling + * @details The GetAlarmSummary ACK service handler is used by a client + * BACnet-user to obtain a summary of "active alarms." + * The term "active alarm" refers to BACnet standard objects + * that have an Event_State property whose value is + * not equal to NORMAL and a Notify_Type property whose + * value is ALARM. * @author Daniel Blazevic * @date 2013 - * @brief GetAlarmSummary ACK service handling - * - * @section LICENSE - * - * Copyright (C) 2013 Daniel Blazevic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - * @section DESCRIPTION - * - * The GetAlarmSummary ACK service handler is used by a client BACnet-user to - * obtain a summary of "active alarms." The term "active alarm" refers to - * BACnet standard objects that have an Event_State property whose value is - * not equal to NORMAL and a Notify_Type property whose value is ALARM. + * @copyright SPDX-License-Identifier: MIT */ #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/service/h_gas_a.h b/src/bacnet/basic/service/h_gas_a.h index 54ca23f3..aa71c9e1 100644 --- a/src/bacnet/basic/service/h_gas_a.h +++ b/src/bacnet/basic/service/h_gas_a.h @@ -1,33 +1,12 @@ /** * @file -* @author Steve Karg -* @date October 2019 * @brief Header file for a basic GetAlarmSummary-Ack service handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +* @author Steve Karg +* @date 2013 +* @copyright SPDX-License-Identifier: MIT */ -#ifndef GET_ALARM_SUMMARY_ACK_HANDLER_H -#define GET_ALARM_SUMMARY_ACK_HANDLER_H - +#ifndef BACNET_BASIC_SERVICE_GET_ALARM_SUMMARY_ACK_HANDLER_H +#define BACNET_BASIC_SERVICE_GET_ALARM_SUMMARY_ACK_HANDLER_H #include #include #include diff --git a/src/bacnet/basic/service/h_get_alarm_sum.c b/src/bacnet/basic/service/h_get_alarm_sum.c index 6a8236a4..4281343a 100644 --- a/src/bacnet/basic/service/h_get_alarm_sum.c +++ b/src/bacnet/basic/service/h_get_alarm_sum.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2011 Krzysztof Malorny - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief A basic GetAlarmSummary-Request service handler + * @author Krzysztof Malorny + * @date 2011 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -39,8 +22,6 @@ #include "bacnet/basic/services.h" #include "bacnet/datalink/datalink.h" -/** @file h_alarm_sum.c Handles Get Alarm Summary request. */ - static get_alarm_summary_function Get_Alarm_Summary[MAX_BACNET_OBJECT_TYPE]; void handler_get_alarm_summary_set( diff --git a/src/bacnet/basic/service/h_get_alarm_sum.h b/src/bacnet/basic/service/h_get_alarm_sum.h index 035bfba8..8f3faa1a 100644 --- a/src/bacnet/basic/service/h_get_alarm_sum.h +++ b/src/bacnet/basic/service/h_get_alarm_sum.h @@ -1,33 +1,12 @@ /** -* @file -* @author Steve Karg -* @date October 2019 -* @brief Header file for a basic GetAlarmSummary service handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef HANDLER_GET_ALARM_SUMMARY_H -#define HANDLER_GET_ALARM_SUMMARY_H - + * @file + * @brief Header file for a basic GetAlarmSummary service handler + * @author Krzysztof Malorny + * @date 2011 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_SERVICE_HANDLER_GET_ALARM_SUMMARY_H +#define BACNET_BASIC_SERVICE_HANDLER_GET_ALARM_SUMMARY_H #include #include #include diff --git a/src/bacnet/basic/service/h_getevent.c b/src/bacnet/basic/service/h_getevent.c index 675c9605..1644bee7 100644 --- a/src/bacnet/basic/service/h_getevent.c +++ b/src/bacnet/basic/service/h_getevent.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2009 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief Handles Get Event Information request. + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -43,8 +26,6 @@ #include "bacnet/basic/services.h" #include "bacnet/datalink/datalink.h" -/** @file h_getevent.c Handles Get Event Information request. */ - static get_event_info_function Get_Event_Info[MAX_BACNET_OBJECT_TYPE]; /** print eventState diff --git a/src/bacnet/basic/service/h_getevent.h b/src/bacnet/basic/service/h_getevent.h index b15bab26..d3a49e55 100644 --- a/src/bacnet/basic/service/h_getevent.h +++ b/src/bacnet/basic/service/h_getevent.h @@ -1,32 +1,12 @@ /** -* @file -* @author Steve Karg -* @date October 2019 -* @brief Header file for a basic GetEventInformation service handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef HANDLER_GET_EVENT_INFORMATION_H -#define HANDLER_GET_EVENT_INFORMATION_H + * @file + * @brief Header file for a basic GetEventInformation service handler + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_SERVICE_HANDLER_GET_EVENT_INFORMATION_H +#define BACNET_BASIC_SERVICE_HANDLER_GET_EVENT_INFORMATION_H #include #include diff --git a/src/bacnet/basic/service/h_getevent_a.c b/src/bacnet/basic/service/h_getevent_a.c index bc0cbd45..72bec27a 100644 --- a/src/bacnet/basic/service/h_getevent_a.c +++ b/src/bacnet/basic/service/h_getevent_a.c @@ -1,40 +1,15 @@ /** * @file + * @brief A basic GetEventNotification-ACK service handling + * @details The GetEventInformation service ACK service handler is used + * by a client BACnet-user to obtain a summary of all "active event states". + * The term "active event states" refers to all event-initiating objects + * that have an Event_State property whose value is not equal to NORMAL, + * or have an Acked_Transitions property, which has at least one of the bits + * (TO-OFFNORMAL, TO-FAULT, TONORMAL) set to FALSE. * @author Daniel Blazevic * @date 2014 - * @brief GetEvent ACK service handling - * - * @section LICENSE - * - * Copyright (C) 2014 Daniel Blazevic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - * @section DESCRIPTION - * - * The GetEventInformation service ACK service handler is used by a client - * BACnet-user to obtain a summary of all "active event states". The term - * "active event states" refers to all event-initiating objects that have an - * Event_State property whose value is not equal to NORMAL, or have an - * Acked_Transitions property, which has at least one of the bits - * (TO-OFFNORMAL, TO-FAULT, TONORMAL) set to FALSE. + * @copyright SPDX-License-Identifier: MIT */ #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/service/h_getevent_a.h b/src/bacnet/basic/service/h_getevent_a.h index 8b4f0fef..e49ebc2d 100644 --- a/src/bacnet/basic/service/h_getevent_a.h +++ b/src/bacnet/basic/service/h_getevent_a.h @@ -1,32 +1,12 @@ /** -* @file -* @author Steve Karg -* @date October 2019 -* @brief Header file for a basic GetEventNotification-Ack service handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef GET_EVENT_ACK_HANDLER_H -#define GET_EVENT_ACK_HANDLER_H + * @file + * @brief Header file for a basic GetEventNotification-Ack service handler + * @author Daniel Blazevic + * @date 2014 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_SERVICE_GET_EVENT_ACK_HANDLER_H +#define BACNET_BASIC_SERVICE_GET_EVENT_ACK_HANDLER_H #include #include diff --git a/src/bacnet/basic/service/h_iam.c b/src/bacnet/basic/service/h_iam.c index ae76d42b..2f53f254 100644 --- a/src/bacnet/basic/service/h_iam.c +++ b/src/bacnet/basic/service/h_iam.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2005 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief A basic I-Am service handler + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -34,8 +17,6 @@ #include "bacnet/basic/services.h" #include "bacnet/basic/tsm/tsm.h" -/** @file h_iam.c Handles I-Am requests. */ - /** Handler for I-Am responses. * Will add the responder to our cache, or update its binding. * @ingroup DMDDB diff --git a/src/bacnet/basic/service/h_iam.h b/src/bacnet/basic/service/h_iam.h index 05fde619..cc7a39a9 100644 --- a/src/bacnet/basic/service/h_iam.h +++ b/src/bacnet/basic/service/h_iam.h @@ -1,33 +1,12 @@ /** -* @file -* @author Steve Karg -* @date October 2019 -* @brief Header file for a basic I-Am service handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef HANDLER_I_AM_H -#define HANDLER_I_AM_H - + * @file + * @brief Header file for a basic I-Am service handler + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_SERVICE_HANDLER_I_AM_H +#define BACNET_BASIC_SERVICE_HANDLER_I_AM_H #include #include #include diff --git a/src/bacnet/basic/service/h_ihave.c b/src/bacnet/basic/service/h_ihave.c index a7e169eb..79b26e0e 100644 --- a/src/bacnet/basic/service/h_ihave.c +++ b/src/bacnet/basic/service/h_ihave.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief A basic I-Have service handler + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -34,8 +17,6 @@ #include "bacnet/basic/services.h" #include "bacnet/basic/tsm/tsm.h" -/** @file h_ihave.c Handles incoming I-Have messages. */ - /** Simple Handler for I-Have responses (just validates response). * @ingroup DMDOB * @param service_request [in] The received message to be handled. diff --git a/src/bacnet/basic/service/h_ihave.h b/src/bacnet/basic/service/h_ihave.h index 8e0a9de6..4b5a5448 100644 --- a/src/bacnet/basic/service/h_ihave.h +++ b/src/bacnet/basic/service/h_ihave.h @@ -1,33 +1,12 @@ /** -* @file -* @author Steve Karg -* @date October 2019 -* @brief Header file for a basic I-Have service handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef HANDLER_I_HAVE_H -#define HANDLER_I_HAVE_H - + * @file + * @brief Header file for a basic I-Have service handler + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_SERVICE_HANDLER_I_HAVE_H +#define BACNET_BASIC_SERVICE_HANDLER_I_HAVE_H #include #include #include diff --git a/src/bacnet/basic/service/h_list_element.c b/src/bacnet/basic/service/h_list_element.c index 1e642649..49da814d 100644 --- a/src/bacnet/basic/service/h_list_element.c +++ b/src/bacnet/basic/service/h_list_element.c @@ -3,11 +3,7 @@ * @brief AddListElement and RemoveListElement service application handlers * @author Steve Karg * @date December 2022 - * @section LICENSE - * - * Copyright (C) 2022 Steve Karg - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #include #include diff --git a/src/bacnet/basic/service/h_list_element.h b/src/bacnet/basic/service/h_list_element.h index ac229463..7fe58409 100644 --- a/src/bacnet/basic/service/h_list_element.h +++ b/src/bacnet/basic/service/h_list_element.h @@ -3,15 +3,10 @@ * @brief API for AddListElement and RemoveListElement application handlers * @author Steve Karg * @date December 2022 - * @section LICENSE - * - * Copyright (C) 2022 Steve Karg - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ -#ifndef HANDLER_LIST_ELEMENT_H -#define HANDLER_LIST_ELEMENT_H - +#ifndef BACNET_BASIC_SERVICE_HANDLER_LIST_ELEMENT_H +#define BACNET_BASIC_SERVICE_HANDLER_LIST_ELEMENT_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/service/h_lso.c b/src/bacnet/basic/service/h_lso.c index 75c8a93f..6b6fc99d 100644 --- a/src/bacnet/basic/service/h_lso.c +++ b/src/bacnet/basic/service/h_lso.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2005 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief A basic LifeSafetyOperation service handler + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -41,8 +24,6 @@ #include "bacnet/basic/object/device.h" #include "bacnet/datalink/datalink.h" -/** @file h_lso.c Handles BACnet Life Safey Operation messages. */ - void handler_lso(uint8_t *service_request, uint16_t service_len, BACNET_ADDRESS *src, diff --git a/src/bacnet/basic/service/h_lso.h b/src/bacnet/basic/service/h_lso.h index 05a95b8b..364f6f13 100644 --- a/src/bacnet/basic/service/h_lso.h +++ b/src/bacnet/basic/service/h_lso.h @@ -1,33 +1,12 @@ /** -* @file -* @author Steve Karg -* @date October 2019 -* @brief Header file for a basic LifeSafetyOperation service handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef HANDLER_LIFE_SAFETY_OPERATION_H -#define HANDLER_LIFE_SAFETY_OPERATION_H - + * @file + * @brief Header file for a basic LifeSafetyOperation service handler + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_SERVICE_HANDLER_LIFE_SAFETY_OPERATION_H +#define BACNET_BASIC_SERVICE_HANDLER_LIFE_SAFETY_OPERATION_H #include #include #include diff --git a/src/bacnet/basic/service/h_noserv.c b/src/bacnet/basic/service/h_noserv.c index 050da4d6..8019ca70 100644 --- a/src/bacnet/basic/service/h_noserv.c +++ b/src/bacnet/basic/service/h_noserv.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2005 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief A basic unrecognized/unsupported service handler + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -40,8 +23,6 @@ #include "bacnet/basic/services.h" #include "bacnet/datalink/datalink.h" -/** @file noserv.c Handles an unrecognized/unsupported service. */ - /** Handler to be invoked when a Service request is received for which no * handler has been defined. * @ingroup MISCHNDLR diff --git a/src/bacnet/basic/service/h_noserv.h b/src/bacnet/basic/service/h_noserv.h index 3c8f1e42..cf43231b 100644 --- a/src/bacnet/basic/service/h_noserv.h +++ b/src/bacnet/basic/service/h_noserv.h @@ -1,33 +1,12 @@ /** -* @file -* @author Steve Karg -* @date October 2019 -* @brief Header file for a basic unrecognized service handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef UNRECOGNIZED_SERVICE_HANDLER_H -#define UNRECOGNIZED_SERVICE_HANDLER_H - + * @file + * @brief Header file for a basic unrecognized service handler + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_SERVICE_UNRECOGNIZED_HANDLER_H +#define BACNET_BASIC_SERVICE_UNRECOGNIZED_HANDLER_H #include #include #include diff --git a/src/bacnet/basic/service/h_rd.c b/src/bacnet/basic/service/h_rd.c index 87f27162..0aa5b180 100644 --- a/src/bacnet/basic/service/h_rd.c +++ b/src/bacnet/basic/service/h_rd.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2006 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief A basic Reinitialize Device request handler + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -43,8 +26,6 @@ #include "bacnet/basic/services.h" #include "bacnet/datalink/datalink.h" -/** @file h_rd.c Handles Reinitialize Device requests. */ - /** Handler for a Reinitialize Device (RD) request. * @ingroup DMRD * This handler will be invoked by apdu_handler() if it has been enabled diff --git a/src/bacnet/basic/service/h_rd.h b/src/bacnet/basic/service/h_rd.h index 8aec0db3..edf097c9 100644 --- a/src/bacnet/basic/service/h_rd.h +++ b/src/bacnet/basic/service/h_rd.h @@ -1,33 +1,12 @@ /** -* @file -* @author Steve Karg -* @date October 2019 -* @brief Header file for a basic ReinitializeDevice service handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef HANDLER_REINITIALIZE_DEVICE_H -#define HANDLER_REINITIALIZE_DEVICE_H - + * @file + * @brief Header file for a basic ReinitializeDevice service handler + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_SERVICE_HANDLER_REINITIALIZE_DEVICE_H +#define BACNET_BASIC_SERVICE_HANDLER_REINITIALIZE_DEVICE_H #include #include #include diff --git a/src/bacnet/basic/service/h_rp_a.c b/src/bacnet/basic/service/h_rp_a.c index 0eaf3444..3988fbf5 100644 --- a/src/bacnet/basic/service/h_rp_a.c +++ b/src/bacnet/basic/service/h_rp_a.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2005 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @author Steve Karg + * @date 2006 + * @brief A basic ReadProperty-Ack service handler + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include @@ -44,8 +27,6 @@ #define PRINTF debug_aprintf #define PRINTF_ERR debug_perror -/** @file h_rp_a.c Handles Read Property Acknowledgments. */ - /** For debugging... * @param [in] data portion of the ACK */ diff --git a/src/bacnet/basic/service/h_rp_a.h b/src/bacnet/basic/service/h_rp_a.h index 4606789e..0214413d 100644 --- a/src/bacnet/basic/service/h_rp_a.h +++ b/src/bacnet/basic/service/h_rp_a.h @@ -1,33 +1,12 @@ /** -* @file -* @author Steve Karg -* @date October 2019 -* @brief Header file for a basic ReadProperty-Ack service handler -* -* @section LICENSE -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*/ -#ifndef HANDLER_READ_PROPERTY_ACK_H -#define HANDLER_READ_PROPERTY_ACK_H - + * @file + * @author Steve Karg + * @date 2006 + * @brief Header file for a basic ReadProperty-Ack service handler + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BASIC_SERVICE_HANDLER_READ_PROPERTY_ACK_H +#define BACNET_BASIC_SERVICE_HANDLER_READ_PROPERTY_ACK_H #include #include #include diff --git a/src/bacnet/basic/services.h b/src/bacnet/basic/services.h index a55361a1..71d1a540 100644 --- a/src/bacnet/basic/services.h +++ b/src/bacnet/basic/services.h @@ -1,27 +1,10 @@ -/************************************************************************** -* -* Copyright (C) 2005-2006 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ +/** + * @file + * @brief APIs for all the basic BACnet service handlers + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: MIT + */ #ifndef BASIC_SERVICES_H #define BASIC_SERVICES_H /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/sys/bigend.c b/src/bacnet/basic/sys/bigend.c index 6c46610d..10da1a8b 100644 --- a/src/bacnet/basic/sys/bigend.c +++ b/src/bacnet/basic/sys/bigend.c @@ -1,8 +1,12 @@ -/* Derived from "Unix Incompatibility Notes: Byte Order" by Jan Wolter */ -/* http://unixpapa.com/incnote/byteorder.html */ - -/** @file bigend.c Determination of Endianness */ - +/** + * @file + * @brief Determination of host Endianness + * Derived from "Unix Incompatibility Notes: Byte Order" by Jan Wolter + * http://unixpapa.com/incnote/byteorder.html + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + */ #include "bacnet/basic/sys/bigend.h" #ifdef BACNET_BIG_ENDIAN diff --git a/src/bacnet/basic/sys/bigend.h b/src/bacnet/basic/sys/bigend.h index 09647d55..37566d87 100644 --- a/src/bacnet/basic/sys/bigend.h +++ b/src/bacnet/basic/sys/bigend.h @@ -1,29 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef BIGEND_H -#define BIGEND_H - +/** + * @file + * @brief API for determination of host Endianness + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_SYS_BIGEND_H +#define BACNET_SYS_BIGEND_H /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" diff --git a/src/bacnet/basic/sys/bits.h b/src/bacnet/basic/sys/bits.h index 57c762da..e75291fa 100644 --- a/src/bacnet/basic/sys/bits.h +++ b/src/bacnet/basic/sys/bits.h @@ -1,11 +1,9 @@ /** * @file - * @author Steve Karg - * @date 2022 + * @author Steve Karg + * @date 2012 * @brief Bitwise helper macros - * @copyright 2012 Steve Karg - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #ifndef BACNET_SYS_BITS_H #define BACNET_SYS_BITS_H diff --git a/src/bacnet/basic/sys/bytes.h b/src/bacnet/basic/sys/bytes.h index 41988f9b..a1e9a37a 100644 --- a/src/bacnet/basic/sys/bytes.h +++ b/src/bacnet/basic/sys/bytes.h @@ -1,11 +1,9 @@ /** * @file - * @author Steve Karg - * @date 2022 + * @author Steve Karg + * @date 2012 * @brief Defines the bit/byte/word/long conversions that are used in code - * @copyright 2012 Steve Karg - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #ifndef BACNET_SYS_BYTES_H #define BACNET_SYS_BYTES_H diff --git a/src/bacnet/basic/sys/color_rgb.c b/src/bacnet/basic/sys/color_rgb.c index d593ba3d..f9992249 100644 --- a/src/bacnet/basic/sys/color_rgb.c +++ b/src/bacnet/basic/sys/color_rgb.c @@ -1,13 +1,10 @@ /** * @file - * @author Steve Karg - * @date 2022 * @brief computes sRGB to and from from CIE xy and brightness - * - * @section LICENSE - * - * Public domain algorithms from Philips and W3C - * + * @author Steve Karg + * @note Public domain algorithms from Philips and W3C + * @date 2022 + * @copyright SPDX-License-Identifier: CC-PDDC */ #include #include diff --git a/src/bacnet/basic/sys/color_rgb.h b/src/bacnet/basic/sys/color_rgb.h index 2ae13f0f..7321a2b1 100644 --- a/src/bacnet/basic/sys/color_rgb.h +++ b/src/bacnet/basic/sys/color_rgb.h @@ -1,11 +1,12 @@ /** * @file + * @brief API Color sRGB to CIE xy and brightness * @author Steve Karg * @date 2022 - * @brief API Color sRGB to CIE xy and brightness + * @copyright SPDX-License-Identifier: CC-PDDC */ -#ifndef COLOR_RGB_H -#define COLOR_RGB_H +#ifndef BACNET_SYS_COLOR_RGB_H +#define BACNET_SYS_COLOR_RGB_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/sys/days.c b/src/bacnet/basic/sys/days.c index 2e1bbda6..a5ccf5eb 100644 --- a/src/bacnet/basic/sys/days.c +++ b/src/bacnet/basic/sys/days.c @@ -1,14 +1,11 @@ /** * @file - * @author Steve Karg - * @date 1997 * @brief computes days from date, days of the week, days in a month, * days in a year - * - * @section LICENSE - * - * Public domain algorithms from ACM - * + * @note Public domain algorithms from ACM + * @author Steve Karg + * @date 1997 + * @copyright SPDX-License-Identifier: CC-PDDC */ #include #include diff --git a/src/bacnet/basic/sys/days.h b/src/bacnet/basic/sys/days.h index 2b6c918d..876d40c1 100644 --- a/src/bacnet/basic/sys/days.h +++ b/src/bacnet/basic/sys/days.h @@ -1,8 +1,9 @@ /** * @file + * @brief This file contains the function prototypes for the days calculations * @author Steve Karg * @date 1997 - * @brief This file contains the function prototypes for the days calculations + * @copyright SPDX-License-Identifier: CC-PDDC */ #ifndef DAYS_H #define DAYS_H diff --git a/src/bacnet/basic/sys/debug.c b/src/bacnet/basic/sys/debug.c index eee198d9..2bd9969e 100644 --- a/src/bacnet/basic/sys/debug.c +++ b/src/bacnet/basic/sys/debug.c @@ -1,37 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2008 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ - +/** + * @file + * @brief Debug print function + * @author Steve Karg + * @date 2008 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* for standard integer types uint8_t etc. */ #include /* for the standard bool type. */ #include /* Standard I/O */ @@ -45,7 +18,6 @@ #if DEBUG_PRINTF_WITH_TIMESTAMP #include "bacnet/datetime.h" #endif -/** @file debug.c Debug print function */ #if DEBUG_PRINTF_WITH_TIMESTAMP /** diff --git a/src/bacnet/basic/sys/debug.h b/src/bacnet/basic/sys/debug.h index 14059962..68d94044 100644 --- a/src/bacnet/basic/sys/debug.h +++ b/src/bacnet/basic/sys/debug.h @@ -1,29 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef DEBUG_H -#define DEBUG_H - +/** + * @file + * @brief API for debug print function + * @author Steve Karg + * @date 2008 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_SYS_DEBUG_H +#define BACNET_SYS_DEBUG_H #include #include #include diff --git a/src/bacnet/basic/sys/fifo.c b/src/bacnet/basic/sys/fifo.c index b57bd88a..4ab69c9e 100644 --- a/src/bacnet/basic/sys/fifo.c +++ b/src/bacnet/basic/sys/fifo.c @@ -1,40 +1,9 @@ /** * @file - * @author Steve Karg - * @date 2004 * @brief Generic interrupt safe FIFO library for deeply embedded system. - * - * @section LICENSE - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to: - * The Free Software Foundation, Inc. - * 59 Temple Place - Suite 330 - * Boston, MA 02111-1307 - * USA. - * - * As a special exception, if other files instantiate templates or - * use macros or inline functions from this file, or you compile - * this file and link it with other works to produce a work based - * on this file, this file does not by itself cause the resulting - * work to be covered by the GNU General Public License. However - * the source code for this file must still be made available in - * accordance with section (3) of the GNU General Public License. - * - * This exception does not invalidate any other reasons why a work - * based on this file might be covered by the GNU General Public - * License. - * + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 * @section DESCRIPTION * * Generic interrupt safe FIFO library for deeply embedded system diff --git a/src/bacnet/basic/sys/fifo.h b/src/bacnet/basic/sys/fifo.h index 9c4c3887..53031ad0 100644 --- a/src/bacnet/basic/sys/fifo.h +++ b/src/bacnet/basic/sys/fifo.h @@ -1,11 +1,12 @@ /** -* @file -* @author Steve Karg -* @date 2004 + * @file + * @brief Generic interrupt safe FIFO library for deeply embedded system. + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT */ -#ifndef FIFO_H -#define FIFO_H - +#ifndef BACNET_SYS_FIFO_H +#define BACNET_SYS_FIFO_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/basic/sys/filename.c b/src/bacnet/basic/sys/filename.c index 7a6e71f9..a4a1fb15 100644 --- a/src/bacnet/basic/sys/filename.c +++ b/src/bacnet/basic/sys/filename.c @@ -1,42 +1,14 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2006 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief Function for filename manipulation + * @author Steve Karg + * @date 2007 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include #include "bacnet/basic/sys/filename.h" -/** @file filename.c Function for filename manipulation */ - char *filename_remove_path(const char *filename_in) { char *filename_out = (char *)filename_in; diff --git a/src/bacnet/basic/sys/filename.h b/src/bacnet/basic/sys/filename.h index 0b031f42..07367d54 100644 --- a/src/bacnet/basic/sys/filename.h +++ b/src/bacnet/basic/sys/filename.h @@ -1,29 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef FILENAME_H -#define FILENAME_H - +/** + * @file + * @brief API for functions used to manipulate filenames + * @author Steve Karg + * @date 2007 + * @copyright SPDX-License-Identifier: MIT +*/ +#ifndef BACNET_SYS_FILENAME_H +#define BACNET_SYS_FILENAME_H /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" diff --git a/src/bacnet/basic/sys/key.h b/src/bacnet/basic/sys/key.h index 8d887bf4..998da000 100644 --- a/src/bacnet/basic/sys/key.h +++ b/src/bacnet/basic/sys/key.h @@ -1,35 +1,18 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef KEY_H -#define KEY_H - +/** + * @file + * @brief This file has the macros that encode and decode the unique 32 bit + * keys for the keylist when used with BACnet object types and instances + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT +*/ +#ifndef BACNET_SYS_KEY_H +#define BACNET_SYS_KEY_H #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" -/* This file has the macros that encode and decode the */ -/* keys for the keylist when used with BACnet Object Id's */ +/* key used for BACnet object type and instance */ typedef uint32_t KEY; /* assuming a 32 bit KEY */ diff --git a/src/bacnet/basic/sys/keylist.c b/src/bacnet/basic/sys/keylist.c index 1e097896..1e6eae3d 100644 --- a/src/bacnet/basic/sys/keylist.c +++ b/src/bacnet/basic/sys/keylist.c @@ -1,45 +1,14 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2003 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ - -/** @file keylist.c Keyed Linked List Library */ - -/* */ -/* This is an enhanced array of pointers to data. */ -/* The list is sorted, indexed, and keyed. */ -/* The array is much faster than a linked list. */ -/* It stores a pointer to data, which you must */ -/* malloc and free on your own, or just use */ -/* static data */ - +/** + * @file + * @brief Key List library + * @details This is an enhanced array of pointers to data. + * The list is sorted, indexed, and keyed. The array is much faster + * than a linked list. It stores a pointer to data, which you must + * malloc and free on your own, or just use static data. + * @author Steve Karg + * @date 2003 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include #include diff --git a/src/bacnet/basic/sys/keylist.h b/src/bacnet/basic/sys/keylist.h index 0214120e..aa651cae 100644 --- a/src/bacnet/basic/sys/keylist.h +++ b/src/bacnet/basic/sys/keylist.h @@ -1,29 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef KEYLIST_H -#define KEYLIST_H - +/** + * @file + * @brief API for a Key List library + * @author Steve Karg + * @date 2003 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_SYS_KEYLIST_H +#define BACNET_SYS_KEYLIST_H /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" /* BACnet Stack API */ diff --git a/src/bacnet/basic/sys/linear.c b/src/bacnet/basic/sys/linear.c index 2f427e71..a8e5cdcc 100644 --- a/src/bacnet/basic/sys/linear.c +++ b/src/bacnet/basic/sys/linear.c @@ -1,43 +1,16 @@ /** * @file -* @author Steve Karg -* @date 2011 * @brief Performs linear interpolation using single precision floating -* point math or integer math, or a mixture of both. -* -* @section LICENSE -* -* Copyright (C) 2011 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -* @section DESCRIPTION -* -* Performs linear interpolation using single precision floating -* point math or integer math, or a mixture of both. -* Linear interpolation is a method of constructing new data -* points within the range of a discrete set of known data points. +* point math or integer math, or a mixture of both. Linear interpolation +* is a method of constructing new data points within the range of a discrete +* set of known data points. +* @author Steve Karg +* @date 2011 +* @copyright SPDX-License-Identifier: MIT */ #include #include -#include "linear.h" +#include "bacnet/basic/sys/linear.h" /** * Linearly Interpolate the values between y1 and y3 based on x. diff --git a/src/bacnet/basic/sys/linear.h b/src/bacnet/basic/sys/linear.h index 1546db7d..73370389 100644 --- a/src/bacnet/basic/sys/linear.h +++ b/src/bacnet/basic/sys/linear.h @@ -1,10 +1,12 @@ /** * @file -* @author Steve Karg +* @brief API for linear interpolation library +* @author Steve Karg * @date 2011 +* @copyright SPDX-License-Identifier: MIT */ -#ifndef LINEAR_H -#define LINEAR_H +#ifndef BACNET_SYS_LINEAR_H +#define BACNET_SYS_LINEAR_H /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" diff --git a/src/bacnet/basic/sys/mstimer.c b/src/bacnet/basic/sys/mstimer.c index 9f2122b3..a757f610 100644 --- a/src/bacnet/basic/sys/mstimer.c +++ b/src/bacnet/basic/sys/mstimer.c @@ -1,12 +1,7 @@ /** * @file - * @author Steve Karg - * @date 2009 * @brief Millisecond timer library header file. - * - * @section DESCRIPTION - * - * The mstimer library provides functions for setting, resetting and + * @details The mstimer library provides functions for setting, resetting and * restarting timers, and for checking if a timer has expired. An * application must "manually" check if its timers have expired; this * is not done automatically. @@ -14,8 +9,11 @@ * A timer is declared as a \c struct \c mstimer and all access to the * timer is made by a pointer to the declared timer. * - * Adapted from the Contiki operating system. + * @author Steve Karg + * @date 2009 + * @note Adapted from the Contiki operating system. * Original Authors: Adam Dunkels , Nicolas Tsiftes + * @copyright SPDX-License-Identifier: BSD-3-Clause */ #include #include diff --git a/src/bacnet/basic/sys/mstimer.h b/src/bacnet/basic/sys/mstimer.h index 9c1f763e..8700bc83 100644 --- a/src/bacnet/basic/sys/mstimer.h +++ b/src/bacnet/basic/sys/mstimer.h @@ -1,24 +1,12 @@ /** * @file - * @author Steve Karg + * @brief API for millisecond timer library + * @author Steve Karg * @date 2009 - * @brief Millisecond timer library header file. - * - * @section DESCRIPTION - * - * The mstimer library provides functions for setting, resetting and - * restarting timers, and for checking if a timer has expired. An - * application must "manually" check if its timers have expired; this - * is not done automatically. - * - * A timer is declared as a \c struct \c mstimer and all access to the - * timer is made by a pointer to the declared timer. - * - * Adapted from the Contiki operating system. - * Original Authors: Adam Dunkels , Nicolas Tsiftes + * @copyright SPDX-License-Identifier: BSD-3-Clause */ -#ifndef MSTIMER_H_ -#define MSTIMER_H_ +#ifndef BACNET_SYS_MSTIMER_H_ +#define BACNET_SYS_MSTIMER_H_ /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" diff --git a/src/bacnet/basic/sys/platform.h b/src/bacnet/basic/sys/platform.h index d93aafef..d4d3264f 100644 --- a/src/bacnet/basic/sys/platform.h +++ b/src/bacnet/basic/sys/platform.h @@ -1,17 +1,11 @@ /** * @file - * @author Steve Karg + * @author Steve Karg * @date 2022 * @brief Platform libc and compiler abstraction layer - * - * @section DESCRIPTION - * - * This libc and compiler abstraction layer assists with differences + * @details This libc and compiler abstraction layer assists with differences * between compiler and libc versions, capabilities, and C standards. - * - * @copyright 2022 Steve Karg - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #ifndef BACNET_SYS_PLATFORM_H #define BACNET_SYS_PLATFORM_H diff --git a/src/bacnet/basic/sys/ringbuf.c b/src/bacnet/basic/sys/ringbuf.c index 777ecdfa..3f77a4b4 100644 --- a/src/bacnet/basic/sys/ringbuf.c +++ b/src/bacnet/basic/sys/ringbuf.c @@ -1,51 +1,14 @@ /** * @file - * @author Steve Karg - * @date 2004 * @brief Generic ring buffer library for deeply embedded system. - * - * @section LICENSE - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to: - * The Free Software Foundation, Inc. - * 59 Temple Place - Suite 330 - * Boston, MA 02111-1307 - * USA. - * - * As a special exception, if other files instantiate templates or - * use macros or inline functions from this file, or you compile - * this file and link it with other works to produce a work based - * on this file, this file does not by itself cause the resulting - * work to be covered by the GNU General Public License. However - * the source code for this file must still be made available in - * accordance with section (3) of the GNU General Public License. - * - * This exception does not invalidate any other reasons why a work - * based on this file might be covered by the GNU General Public - * License. - * - * @section DESCRIPTION - * - * Generic ring buffer library for deeply embedded system. - * It uses a data store whose size is a power of 2 (8, 16, 32, 64, ...) - * and doesn't waste any data bytes. It has very low overhead, and - * utilizes modulo for indexing the data in the data store. - * It uses separate variables for consumer and producer so it can - * be used in multithreaded environment. - * - * See the unit tests for usage examples. - * + * @details Generic ring buffer library that uses a data store whose size + * is a power of 2 (8, 16, 32, 64, ...) and doesn't waste any data bytes. + * It has very low overhead, and utilizes modulo for indexing the data + * in the data store. The ring buffer uses separate variables for + * consumer and producer so it can be used in multithreaded environment. + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 */ #include #include diff --git a/src/bacnet/basic/sys/ringbuf.h b/src/bacnet/basic/sys/ringbuf.h index b6e354c2..44d9e435 100644 --- a/src/bacnet/basic/sys/ringbuf.h +++ b/src/bacnet/basic/sys/ringbuf.h @@ -1,11 +1,10 @@ /** -* @file -* @author Steve Karg -* @date 2004 -* -* Generic ring buffer library for deeply embedded system. -* See the unit tests for usage examples. -*/ + * @file + * @brief API for a ring buffer library for deeply embedded system. + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + */ #ifndef RINGBUF_H #define RINGBUF_H diff --git a/src/bacnet/basic/sys/sbuf.c b/src/bacnet/basic/sys/sbuf.c index 87c10445..2bbdc65c 100644 --- a/src/bacnet/basic/sys/sbuf.c +++ b/src/bacnet/basic/sys/sbuf.c @@ -1,46 +1,14 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2005 by Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307 - USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ - -/** @file sbuf.c Static buffer library for deeply embedded system. */ - -/* Functional Description: Static buffer library for deeply - embedded system. See the unit tests for usage examples. */ +/** + * @file + * @brief Static buffer library for deeply embedded system. + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include #include -#include "sbuf.h" +#include "bacnet/basic/sys/sbuf.h" void sbuf_init(STATIC_BUFFER *b, /* static buffer structure */ char *data, /* data block */ diff --git a/src/bacnet/basic/sys/sbuf.h b/src/bacnet/basic/sys/sbuf.h index 4a86bb77..c5356998 100644 --- a/src/bacnet/basic/sys/sbuf.h +++ b/src/bacnet/basic/sys/sbuf.h @@ -1,32 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef SBUF_H -#define SBUF_H - -/* Functional Description: Static buffer library for deeply - embedded system. See the unit tests for usage examples. */ - +/** + * @file + * @brief API for a static buffer library for deeply embedded system. + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_SYS_SBUF_H +#define BACNET_SYS_SBUF_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/calendar_entry.c b/src/bacnet/calendar_entry.c index 5de3787b..d61e401e 100644 --- a/src/bacnet/calendar_entry.c +++ b/src/bacnet/calendar_entry.c @@ -4,9 +4,7 @@ * @author Ondřej Hruška * @author Steve Karg * @date May 2022 - * @section LICENSE - * - * SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 */ #include #include "bacnet/calendar_entry.h" @@ -16,8 +14,6 @@ #include "bacnet/datetime.h" #include "bacnet/basic/sys/days.h" -/** @file calendar_entry.c Manipulate BACnet calendar entry values */ - /* * @brief Encode the BACnetCalendarEntry complex data * diff --git a/src/bacnet/calendar_entry.h b/src/bacnet/calendar_entry.h index 9bf96ac7..81d75df1 100644 --- a/src/bacnet/calendar_entry.h +++ b/src/bacnet/calendar_entry.h @@ -4,9 +4,7 @@ * @author Ondřej Hruška * @author Steve Karg * @date August 2023 - * @section LICENSE - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #ifndef BACNET_CALENDAR_ENTRY_H #define BACNET_CALENDAR_ENTRY_H diff --git a/src/bacnet/config.h b/src/bacnet/config.h index 131b4989..c91e3a75 100644 --- a/src/bacnet/config.h +++ b/src/bacnet/config.h @@ -3,11 +3,7 @@ * @brief Default configuration for BACnet Stack library * @author Steve Karg * @date 2004 - * @section LICENSE - * - * Copyright (C) 2004 Steve Karg - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #ifndef BACNET_CONFIG_H_ #define BACNET_CONFIG_H_ diff --git a/src/bacnet/cov.c b/src/bacnet/cov.c index 84056366..02c10d51 100644 --- a/src/bacnet/cov.c +++ b/src/bacnet/cov.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2006 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet Change-of-Value (COV) services encode and decode functions + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" @@ -40,8 +14,6 @@ /* me! */ #include "bacnet/cov.h" -/** @file cov.c Encode/Decode Change of Value (COV) services */ - /* Change-Of-Value Services COV Subscribe COV Subscribe Property diff --git a/src/bacnet/cov.h b/src/bacnet/cov.h index 270cecbb..10b8f67c 100644 --- a/src/bacnet/cov.h +++ b/src/bacnet/cov.h @@ -1,28 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2012 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - *********************************************************************/ -#ifndef COV_H -#define COV_H +/** + * @file + * @brief BACnet Change-of-Value encode and decode functions + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_COV_H +#define BACNET_COV_H #include #include diff --git a/src/bacnet/create_object.c b/src/bacnet/create_object.c index e8f42d22..ba5597bf 100644 --- a/src/bacnet/create_object.c +++ b/src/bacnet/create_object.c @@ -3,9 +3,7 @@ * @brief CreateObject service encode and decode * @author Steve Karg * @date August 2023 - * @section LICENSE - * - * SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 */ #include #include diff --git a/src/bacnet/create_object.h b/src/bacnet/create_object.h index 41887404..52c14061 100644 --- a/src/bacnet/create_object.h +++ b/src/bacnet/create_object.h @@ -3,9 +3,7 @@ * @brief API for CreateObject service encode and decode * @author Steve Karg * @date August 2023 - * @section LICENSE - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #ifndef BACNET_CREATE_OBJECT_H #define BACNET_CREATE_OBJECT_H diff --git a/src/bacnet/credential_authentication_factor.c b/src/bacnet/credential_authentication_factor.c index 3bcc079e..d8dc9b86 100644 --- a/src/bacnet/credential_authentication_factor.c +++ b/src/bacnet/credential_authentication_factor.c @@ -1,27 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2015 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief BACnetCredentialAuthenticationFactor encode and decode functions + * @author Nikola Jelic + * @author Steve Karg + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #include #include "bacnet/credential_authentication_factor.h" #include "bacnet/bacdcode.h" diff --git a/src/bacnet/credential_authentication_factor.h b/src/bacnet/credential_authentication_factor.h index 4a7275c9..c7f62e53 100644 --- a/src/bacnet/credential_authentication_factor.h +++ b/src/bacnet/credential_authentication_factor.h @@ -1,28 +1,11 @@ -/************************************************************************** -* -* Copyright (C) 2015 Nikola Jelic -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ - +/** + * @file + * @brief BACnetCredentialAuthenticationFactor encode and decode functions + * @author Nikola Jelic + * @author Steve Karg + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #ifndef BACNET_CREDENTIAL_AUTHENTICATION_FACTOR_H #define BACNET_CREDENTIAL_AUTHENTICATION_FACTOR_H diff --git a/src/bacnet/dailyschedule.h b/src/bacnet/dailyschedule.h index 34e6fdf8..ec4e5c9a 100644 --- a/src/bacnet/dailyschedule.h +++ b/src/bacnet/dailyschedule.h @@ -1,28 +1,13 @@ -/************************************************************************** - * - * Copyright (C) 2012 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - *********************************************************************/ -#ifndef DAILYSCHEDULE_H -#define DAILYSCHEDULE_H +/** + * @file + * @brief BACnetDailySchedule encode and decode functions + * @author Nikola Jelic + * @author Steve Karg + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_DAILY_SCHEDULE_H +#define BACNET_DAILY_SCHEDULE_H #include #include diff --git a/src/bacnet/datalink/arcnet.h b/src/bacnet/datalink/arcnet.h index 7868e766..235c9fee 100644 --- a/src/bacnet/datalink/arcnet.h +++ b/src/bacnet/datalink/arcnet.h @@ -1,28 +1,14 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef ARCNET_H -#define ARCNET_H +/** + * @file + * @brief BACnet ARCNET datalink interface and defines + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + * @defgroup DLARCNET BACnet ARCNET DataLink Network Layer + * @ingroup DataLink + */ +#ifndef BACNET_ARCNET_H +#define BACNET_ARCNET_H #include #include diff --git a/src/bacnet/datalink/automac.c b/src/bacnet/datalink/automac.c index d3ccb3ca..ac319861 100644 --- a/src/bacnet/datalink/automac.c +++ b/src/bacnet/datalink/automac.c @@ -2,9 +2,10 @@ * @file * @brief BACnet MSTP zero-config auto MAC address * @author Steve Karg - * @date 2010 - * - * SPDX-License-Identifier: MIT + * @date 2011 + * @copyright SPDX-License-Identifier: MIT + * @defgroup DLMSTP BACnet MS/TP DataLink Network Layer + * @ingroup DataLink */ #include #include diff --git a/src/bacnet/datalink/automac.h b/src/bacnet/datalink/automac.h index 27312229..e1f2546b 100644 --- a/src/bacnet/datalink/automac.h +++ b/src/bacnet/datalink/automac.h @@ -1,29 +1,14 @@ -/************************************************************************** -* -* Copyright (C) 2010 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef AUTOMAC_H -#define AUTOMAC_H +/** + * @file + * @brief BACnet MS/TP Auto MAC address functionality + * @author Steve Karg + * @date 2011 + * @copyright SPDX-License-Identifier: MIT + * @defgroup DLMSTP BACnet MS/TP DataLink Network Layer + * @ingroup DataLink + */ +#ifndef BACNET_AUTOMAC_H +#define BACNET_AUTOMAC_H #include #include @@ -32,7 +17,6 @@ /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" -/* MS/TP Auto MAC address functionality */ /* starting number available for AutoMAC */ #define MSTP_MAC_SLOTS_OFFSET 32 /* total number of slots */ diff --git a/src/bacnet/datalink/bacsec.c b/src/bacnet/datalink/bacsec.c index 09c28892..4bb9803e 100644 --- a/src/bacnet/datalink/bacsec.c +++ b/src/bacnet/datalink/bacsec.c @@ -1,27 +1,10 @@ -/************************************************************************** - * - * Copyright (C) 2015 Nikola Jelic - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief BACnet Security Wrapper module from Clause 24 of the BACnet Standard. + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #include #include #include diff --git a/src/bacnet/datalink/bacsec.h b/src/bacnet/datalink/bacsec.h index dcceeaea..f2a6efa8 100644 --- a/src/bacnet/datalink/bacsec.h +++ b/src/bacnet/datalink/bacsec.h @@ -1,27 +1,10 @@ -/************************************************************************** -* -* Copyright (C) 2015 Nikola Jelic -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ +/** + * @file + * @brief BACnet Security Wrapper module from Clause 24 of the BACnet Standard. + * @author Nikola Jelic + * @date 2015 + * @copyright SPDX-License-Identifier: MIT + */ #ifndef BACNET_SECURITY_H #define BACNET_SECURITY_H diff --git a/src/bacnet/datalink/bip.h b/src/bacnet/datalink/bip.h index b77b4a71..db1379f7 100644 --- a/src/bacnet/datalink/bip.h +++ b/src/bacnet/datalink/bip.h @@ -1,28 +1,13 @@ -/************************************************************************** - * - * Copyright (C) 2012 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - *********************************************************************/ -#ifndef BIP_H -#define BIP_H +/** + * @file + * @brief BACnet/IP datalink API and defines + * @author Steve Karg + * @date 2004 + * @ingroup DataLink + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_BIP_H +#define BACNET_BIP_H #include #include diff --git a/src/bacnet/datalink/bip6.h b/src/bacnet/datalink/bip6.h index ae1aa746..acc3e605 100644 --- a/src/bacnet/datalink/bip6.h +++ b/src/bacnet/datalink/bip6.h @@ -1,17 +1,18 @@ /** * @file +* @brief BACnet/IPv6 datalink API and defines * @author Steve Karg * @date 2015 +* @copyright SPDX-License-Identifier: MIT +* @details Implementation of the Network Layer using BACnet/IPv6 as the transport, +* as described in ASHRAE 135 Annex J. +* The functions described here fulfill the roles defined generically at the +* DataLink level by serving as the implementation of the function templates. * @defgroup DLBIP6 BACnet/IPv6 DataLink Network Layer * @ingroup DataLink -* -* Implementation of the Network Layer using BACnet/IPv6 as the transport, as -* described in Annex J. -* The functions described here fulfill the roles defined generically at the -* DataLink level by serving as the implementation of the function templates. */ -#ifndef BIP6_H -#define BIP6_H +#ifndef BACNET_BIP6_H +#define BACNET_BIP6_H #include #include diff --git a/src/bacnet/datalink/bvlc.c b/src/bacnet/datalink/bvlc.c index a95b5460..9abba683 100644 --- a/src/bacnet/datalink/bvlc.c +++ b/src/bacnet/datalink/bvlc.c @@ -1,37 +1,12 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2020 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ - +/** + * @file + * @brief BACnet/IP virtual link control module encode and decode + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + * @defgroup DLBIP BACnet/IP DataLink Network Layer + * @ingroup DataLink + */ #include #include #include diff --git a/src/bacnet/datalink/bvlc.h b/src/bacnet/datalink/bvlc.h index cfd5f5d3..2a84ef52 100644 --- a/src/bacnet/datalink/bvlc.h +++ b/src/bacnet/datalink/bvlc.h @@ -1,28 +1,14 @@ -/************************************************************************** - * - * Copyright (C) 2012 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - *********************************************************************/ -#ifndef BVLC_H -#define BVLC_H +/** + * @file + * @brief BACnet/IP virtual link control module encode and decode + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + * @defgroup DLBIP BACnet/IP DataLink Network Layer + * @ingroup DataLink + */ +#ifndef BACNET_BVLC_H +#define BACNET_BVLC_H #include #include diff --git a/src/bacnet/datalink/bvlc6.c b/src/bacnet/datalink/bvlc6.c index 1b121691..c6be467b 100644 --- a/src/bacnet/datalink/bvlc6.c +++ b/src/bacnet/datalink/bvlc6.c @@ -1,37 +1,12 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2015 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ - +/** + * @file + * @brief BACnet/IPv6 virtual link control module encode and decode + * @author Steve Karg + * @date 2015 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + * @defgroup DLBIP6 BACnet/IPv6 DataLink Network Layer + * @ingroup DataLink + */ #include /* for standard integer types uint8_t etc. */ #include /* for the standard bool type. */ #include diff --git a/src/bacnet/datalink/bvlc6.h b/src/bacnet/datalink/bvlc6.h index 11a665ec..e1e2f79f 100644 --- a/src/bacnet/datalink/bvlc6.h +++ b/src/bacnet/datalink/bvlc6.h @@ -1,14 +1,14 @@ /** -* @file -* @author Steve Karg -* @date 2015 -* -* Implementation of the BACnet Virtual Link Layer using IPv6, -* as described in Annex J. -*/ -#ifndef BVLC6_H -#define BVLC6_H - + * @file + * @brief Implementation of the BACnet Virtual Link Layer using IPv6 + * @author Steve Karg + * @date 2015 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + * @defgroup DLBIP BACnet/IP DataLink Network Layer + * @ingroup DataLink + */ +#ifndef BACNET_BVLC6_H +#define BACNET_BVLC6_H #include #include #include diff --git a/src/bacnet/datalink/cobs.c b/src/bacnet/datalink/cobs.c index 0166446b..d14d7bfe 100644 --- a/src/bacnet/datalink/cobs.c +++ b/src/bacnet/datalink/cobs.c @@ -1,26 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2014 Kerry Lynn - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - *********************************************************************/ +/** + * @file + * @brief BACnet MSTP COBS encoding for extended frames + * @author Kerry Lynn + * @date 2014 + * @copyright SPDX-License-Identifier: MIT + * @defgroup DLMSTP BACnet MS/TP DataLink Network Layer + * @ingroup DataLink + */ #include #include #include "bacnet/datalink/mstpdef.h" diff --git a/src/bacnet/datalink/cobs.h b/src/bacnet/datalink/cobs.h index dda562f1..bacc87a6 100644 --- a/src/bacnet/datalink/cobs.h +++ b/src/bacnet/datalink/cobs.h @@ -1,28 +1,14 @@ -/************************************************************************** - * - * Copyright (C) 2014 Kerry Lynn - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - *********************************************************************/ -#ifndef COBS_H -#define COBS_H +/** + * @file + * @brief BACnet MSTP COBS encoding for extended frames + * @author Kerry Lynn + * @date 2014 + * @copyright SPDX-License-Identifier: MIT + * @defgroup DLMSTP BACnet MS/TP DataLink Network Layer + * @ingroup DataLink + */ +#ifndef BACNET_COBS_H +#define BACNET_COBS_H #include #include diff --git a/src/bacnet/datalink/crc.c b/src/bacnet/datalink/crc.c index 5004c079..6ac5c92d 100644 --- a/src/bacnet/datalink/crc.c +++ b/src/bacnet/datalink/crc.c @@ -1,44 +1,17 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2004 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307 - USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet MS/TP datalink CRC calculations + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + * @defgroup DLMSTP BACnet MS/TP DataLink Network Layer + * @ingroup DataLink + */ #include #include #include #include "crc.h" -/** @file crc.c Calculate CRCs */ - #if defined(CRC_USE_TABLE) /* note: table is created using unit test below */ static const uint8_t HeaderCRC[256] = { 0x00, 0xfe, 0xff, 0x01, 0xfd, 0x03, diff --git a/src/bacnet/datalink/crc.h b/src/bacnet/datalink/crc.h index 96fdaecd..83f9259a 100644 --- a/src/bacnet/datalink/crc.h +++ b/src/bacnet/datalink/crc.h @@ -1,28 +1,14 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef CRC_H -#define CRC_H +/** + * @file + * @brief BACnet MS/TP datalink CRC encode and decode + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + * @defgroup DLMSTP BACnet MS/TP DataLink Network Layer + * @ingroup DataLink + */ +#ifndef BACNET_CRC_H +#define BACNET_CRC_H #include #include diff --git a/src/bacnet/datalink/datalink.c b/src/bacnet/datalink/datalink.c index 2d94c63d..81320a19 100644 --- a/src/bacnet/datalink/datalink.c +++ b/src/bacnet/datalink/datalink.c @@ -1,37 +1,12 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2007 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ -/** @file datalink.c Optional run-time assignment of datalink transport */ +/** + * @file + * @brief Optional run-time assignment of BACnet datalink transport + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + * @defgroup DataLink DataLink Network Layer + * @ingroup DataLink + */ #include "bacnet/datalink/datalink.h" #if defined(BACDL_ALL) || defined FOR_DOXYGEN diff --git a/src/bacnet/datalink/datalink.h b/src/bacnet/datalink/datalink.h index 2fbe53f3..715edf34 100644 --- a/src/bacnet/datalink/datalink.h +++ b/src/bacnet/datalink/datalink.h @@ -1,28 +1,13 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef DATALINK_H -#define DATALINK_H +/** + * @file + * @brief Optional run-time assignment of BACnet datalink transport + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + * @ingroup DataLink + */ +#ifndef BACNET_DATALINK_H +#define BACNET_DATALINK_H /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" diff --git a/src/bacnet/datalink/dlenv.c b/src/bacnet/datalink/dlenv.c index eec4d1d5..ba498069 100644 --- a/src/bacnet/datalink/dlenv.c +++ b/src/bacnet/datalink/dlenv.c @@ -1,29 +1,11 @@ -/************************************************************************** - * - * Copyright (C) 2009 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ - -/* environment variables used for the command line tools */ +/** + * @file + * @brief Environment variables used for the BACnet command line tools + * @author Steve Karg + * @date 2009 + * @copyright SPDX-License-Identifier: MIT + * @ingroup DataLink + */ #include #include #include diff --git a/src/bacnet/datalink/dlenv.h b/src/bacnet/datalink/dlenv.h index be58d2c5..07cf03ef 100644 --- a/src/bacnet/datalink/dlenv.h +++ b/src/bacnet/datalink/dlenv.h @@ -1,29 +1,13 @@ -/************************************************************************** -* -* Copyright (C) 2009 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef DLENV_H -#define DLENV_H +/** + * @file + * @brief Environment variables used for the BACnet command line tools + * @author Steve Karg + * @date 2009 + * @copyright SPDX-License-Identifier: MIT + * @ingroup DataLink + */ +#ifndef BACNET_DLENV_H +#define BACNET_DLENV_H #include #include #include diff --git a/src/bacnet/datalink/dlmstp.c b/src/bacnet/datalink/dlmstp.c index 2516725a..bbb43c6d 100644 --- a/src/bacnet/datalink/dlmstp.c +++ b/src/bacnet/datalink/dlmstp.c @@ -2,10 +2,10 @@ * @file * @author Steve Karg * @date February 2023 - * @brief Datalink MS/TP Interface - * - * SPDX-License-Identifier: MIT - * + * @brief Implementation of the Network Layer using BACnet MS/TP transport + * @copyright SPDX-License-Identifier: MIT + * @defgroup DLMSTP BACnet MS/TP DataLink Network Layer + * @ingroup DataLink */ #include #include diff --git a/src/bacnet/datalink/dlmstp.h b/src/bacnet/datalink/dlmstp.h index fe6aa900..368ce389 100644 --- a/src/bacnet/datalink/dlmstp.h +++ b/src/bacnet/datalink/dlmstp.h @@ -1,28 +1,14 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef DLMSTP_H -#define DLMSTP_H +/** + * @file + * @brief API for the Network Layer using BACnet MS/TP as the transport + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + * @defgroup DLMSTP BACnet MS/TP DataLink Network Layer + * @ingroup DataLink + */ +#ifndef BACNET_DLMSTP_H +#define BACNET_DLMSTP_H #include #include diff --git a/src/bacnet/datalink/ethernet.h b/src/bacnet/datalink/ethernet.h index a3015bef..7064069a 100644 --- a/src/bacnet/datalink/ethernet.h +++ b/src/bacnet/datalink/ethernet.h @@ -1,28 +1,14 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef ETHERNET_H -#define ETHERNET_H +/** + * @file + * @author Steve Karg + * @date 2004 + * @brief Implementation of the Network Layer using BACnet Ethernet transport + * @copyright SPDX-License-Identifier: MIT + * @defgroup DL_ETHERNET BACnet Ethernet DataLink Network Layer + * @ingroup DataLink + */ +#ifndef BACNET_ETHERNET_H +#define BACNET_ETHERNET_H #include #include diff --git a/src/bacnet/datalink/mstp.c b/src/bacnet/datalink/mstp.c index a40b990f..399c85d6 100644 --- a/src/bacnet/datalink/mstp.c +++ b/src/bacnet/datalink/mstp.c @@ -1,51 +1,24 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2003-2007 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307 - USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ - -/** @file mstp.c BACnet Master-Slave Twisted Pair (MS/TP) functions */ - -/* This clause describes a Master-Slave/Token-Passing (MS/TP) data link */ -/* protocol, which provides the same services to the network layer as */ -/* ISO 8802-2 Logical Link Control. It uses services provided by the */ -/* EIA-485 physical layer. Relevant clauses of EIA-485 are deemed to be */ -/* included in this standard by reference. The following hardware is assumed: */ -/* (a) A UART (Universal Asynchronous Receiver/Transmitter) capable of */ -/* transmitting and receiving eight data bits with one stop bit */ -/* and no parity. */ -/* (b) An EIA-485 transceiver whose driver may be disabled. */ -/* (c) A timer with a resolution of five milliseconds or less */ - +/** + * @file + * @brief Implementation of the finite state machines + * and BACnet Master-Slave Twisted Pair (MS/TP) functions + * @author Steve Karg + * @date 2003 + * @details This clause describes a Master-Slave/Token-Passing (MS/TP) + * data link protocol, which provides the same services to the network layer + * as ISO 8802-2 Logical Link Control. It uses services provided by the + * EIA-485 physical layer. Relevant clauses of EIA-485 are deemed to be + * included in this standard by reference. The following hardware is assumed: + * (a) A UART (Universal Asynchronous Receiver/Transmitter) capable of + * transmitting and receiving eight data bits with one stop bit + * and no parity. + * (b) An EIA-485 transceiver whose driver may be disabled. + * (c) A timer with a resolution of five milliseconds or less + * + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + * @defgroup DLMSTP BACnet MS/TP DataLink Network Layer + * @ingroup DataLink + */ #include #include #include diff --git a/src/bacnet/datalink/mstp.h b/src/bacnet/datalink/mstp.h index 75dfb755..e807a98a 100644 --- a/src/bacnet/datalink/mstp.h +++ b/src/bacnet/datalink/mstp.h @@ -1,29 +1,14 @@ -/************************************************************************** - * - * Copyright (C) 2004 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ -#ifndef MSTP_H -#define MSTP_H +/** + * @file + * @brief API for the BACnet MS/TP finite state machines and their data + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + * @defgroup DLMSTP BACnet MS/TP DataLink + * @ingroup DataLink + */ +#ifndef BACNET_MSTP_H +#define BACNET_MSTP_H #include #include diff --git a/src/bacnet/datalink/mstpdef.h b/src/bacnet/datalink/mstpdef.h index c7aac553..557aacf8 100644 --- a/src/bacnet/datalink/mstpdef.h +++ b/src/bacnet/datalink/mstpdef.h @@ -1,28 +1,14 @@ -/************************************************************************** - * - * Copyright (C) 2012 Steve Karg - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - *********************************************************************/ -#ifndef MSTPDEF_H -#define MSTPDEF_H +/** + * @file + * @brief Defines for the BACnet MS/TP finite state machines + * @author Steve Karg + * @date 2009 + * @copyright SPDX-License-Identifier: MIT + * @defgroup DLMSTP BACnet MS/TP DataLink + * @ingroup DataLink + */ +#ifndef BACNET_MSTPDEF_H +#define BACNET_MSTPDEF_H #include #include diff --git a/src/bacnet/datalink/mstptext.c b/src/bacnet/datalink/mstptext.c index e97119a7..d3d6335b 100644 --- a/src/bacnet/datalink/mstptext.c +++ b/src/bacnet/datalink/mstptext.c @@ -1,36 +1,12 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2007 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief Enumerations to text for BACnet Master-Slave Twisted Pair (MS/TP) + * @author Steve Karg + * @date 2007 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + * @defgroup DLMSTP BACnet MS/TP DataLink Network Layer + * @ingroup DataLink + */ #include #include "bacnet/datalink/mstp.h" #include "bacnet/indtext.h" diff --git a/src/bacnet/datalink/mstptext.h b/src/bacnet/datalink/mstptext.h index 39e2a5ff..aa6a839e 100644 --- a/src/bacnet/datalink/mstptext.h +++ b/src/bacnet/datalink/mstptext.h @@ -1,29 +1,14 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef MSTPTEXT_H -#define MSTPTEXT_H - +/** + * @file + * @brief API for the BACnet MS/TP defines to text functions + * @author Steve Karg + * @date 2007 + * @copyright SPDX-License-Identifier: MIT + * @defgroup DLMSTP BACnet MS/TP DataLink + * @ingroup DataLink + */ +#ifndef BACNET_MSTPTEXT_H +#define BACNET_MSTPTEXT_H /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" diff --git a/src/bacnet/datetime.c b/src/bacnet/datetime.c index 93c04daf..0e929f88 100644 --- a/src/bacnet/datetime.c +++ b/src/bacnet/datetime.c @@ -6,9 +6,7 @@ * @author Greg Shue * @author Ondřej Hruška * @date 2012 - * @section LICENSE - * - * SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 */ #include #include diff --git a/src/bacnet/datetime.h b/src/bacnet/datetime.h index 3ad8d11c..b78bda71 100644 --- a/src/bacnet/datetime.h +++ b/src/bacnet/datetime.h @@ -6,9 +6,7 @@ * @author Greg Shue * @author Ondřej Hruška * @date 2012 - * @section LICENSE - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #ifndef BACNET_DATE_TIME_H #define BACNET_DATE_TIME_H diff --git a/src/bacnet/dcc.c b/src/bacnet/dcc.c index 7f4c8d23..67a5772f 100644 --- a/src/bacnet/dcc.c +++ b/src/bacnet/dcc.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2006 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet DeviceCommunicationControl encode and decode functions + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" @@ -38,8 +12,6 @@ #include "bacnet/bacdcode.h" #include "bacnet/dcc.h" -/** @file dcc.c Enable/Disable Device Communication Control (DCC) */ - /* note: the disable and time are not expected to survive over a power cycle or reinitialization. */ /* note: time duration is given in Minutes, but in order to be accurate, diff --git a/src/bacnet/dcc.h b/src/bacnet/dcc.h index 1408f78a..38a7b1a6 100644 --- a/src/bacnet/dcc.h +++ b/src/bacnet/dcc.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef DCC_H -#define DCC_H +/** + * @file + * @brief BACnet DeviceCommunicationControl encode and decode functions + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_DEVICE_COMMUNICATION_CONTROL_H +#define BACNET_DEVICE_COMMUNICATION_CONTROL_H #include #include diff --git a/src/bacnet/delete_object.c b/src/bacnet/delete_object.c index 6d82da36..ef0ec87d 100644 --- a/src/bacnet/delete_object.c +++ b/src/bacnet/delete_object.c @@ -3,9 +3,7 @@ * @brief DeleteObject service encode and decode * @author Steve Karg * @date August 2023 - * @section LICENSE - * - * SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 */ #include #include diff --git a/src/bacnet/delete_object.h b/src/bacnet/delete_object.h index 083c684f..01f70a91 100644 --- a/src/bacnet/delete_object.h +++ b/src/bacnet/delete_object.h @@ -3,9 +3,7 @@ * @brief API for DeleteObject service encode and decode * @author Steve Karg * @date August 2023 - * @section LICENSE - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #ifndef BACNET_DELETE_OBJECT_H #define BACNET_DELETE_OBJECT_H diff --git a/src/bacnet/event.c b/src/bacnet/event.c index 1188f4fd..f7443975 100644 --- a/src/bacnet/event.c +++ b/src/bacnet/event.c @@ -1,36 +1,11 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2008 John Minack - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet EventNotification encode and decode functions + * @author John Minack + * @author Steve Karg + * @date 2008 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include "bacnet/event.h" #include "bacnet/bacdcode.h" diff --git a/src/bacnet/event.h b/src/bacnet/event.h index 4bd755eb..ff82a2f8 100644 --- a/src/bacnet/event.h +++ b/src/bacnet/event.h @@ -1,26 +1,11 @@ -/************************************************************************** -* -* Copyright (C) 2008 John Minack -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ +/** + * @file + * @brief BACnet EventNotification encode and decode functions + * @author John Minack + * @author Steve Karg + * @date 2008 + * @copyright SPDX-License-Identifier: MIT + */ #ifndef BACNET_EVENT_H_ #define BACNET_EVENT_H_ diff --git a/src/bacnet/get_alarm_sum.c b/src/bacnet/get_alarm_sum.c index eb641942..3f6f4601 100644 --- a/src/bacnet/get_alarm_sum.c +++ b/src/bacnet/get_alarm_sum.c @@ -3,30 +3,7 @@ * @author Krzysztof Malorny * @date 2011 * @brief GetAlarmSummary service encoding and decoding - * - * @section LICENSE - * - * Copyright (C) 2011 Krzysztof Malorny - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 * @section DESCRIPTION * * The GetAlarmSummary service is used by a client BACnet-user diff --git a/src/bacnet/get_alarm_sum.h b/src/bacnet/get_alarm_sum.h index 00958ea3..8d597a63 100644 --- a/src/bacnet/get_alarm_sum.h +++ b/src/bacnet/get_alarm_sum.h @@ -1,30 +1,13 @@ -/************************************************************************** -* -* Copyright (C) 2011 Krzysztof Malorny -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ - -#ifndef BACNET_GET_ALARM_SUM_H_ -#define BACNET_GET_ALARM_SUM_H_ +/** + * @file + * @brief BACnet GetAlarmSummary encode and decode functions + * @author Krzysztof Malorny + * @author Steve Karg + * @date 2011 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_GET_ALARM_SUMMARY_H_ +#define BACNET_GET_ALARM_SUMMARY_H_ #include #include diff --git a/src/bacnet/getevent.c b/src/bacnet/getevent.c index c1f3407a..3bc4e6ce 100644 --- a/src/bacnet/getevent.c +++ b/src/bacnet/getevent.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2009 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet GetEventNotification encode and decode functions + * @author Steve Karg + * @date 2009 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" @@ -38,8 +12,6 @@ #include "bacnet/bacdcode.h" #include "bacnet/getevent.h" -/** @file getevent.c Encode/Decode GetEvent services */ - /** * @brief Encode APDU for GetEvent-Request service * @param apdu Pointer to a buffer, or NULL for length diff --git a/src/bacnet/getevent.h b/src/bacnet/getevent.h index 56dd0ff4..f7157956 100644 --- a/src/bacnet/getevent.h +++ b/src/bacnet/getevent.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef GETEVENT_H -#define GETEVENT_H +/** + * @file + * @brief BACnet GetEventNotification encode and decode functions + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_GET_EVENT_H +#define BACNET_GET_EVENT_H #include #include diff --git a/src/bacnet/hostnport.c b/src/bacnet/hostnport.c index 605b57f1..64db5c05 100644 --- a/src/bacnet/hostnport.c +++ b/src/bacnet/hostnport.c @@ -3,11 +3,7 @@ * @brief BACnetHostNPort complex data type encode and decode * @author Steve Karg * @date May 2022 - * @section LICENSE - * - * Copyright (C) 2022 Steve Karg - * - * SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 */ #include #include diff --git a/src/bacnet/hostnport.h b/src/bacnet/hostnport.h index 67fd0367..9836c058 100644 --- a/src/bacnet/hostnport.h +++ b/src/bacnet/hostnport.h @@ -3,11 +3,7 @@ * @brief API for BACnetHostNPort complex data type encode and decode * @author Steve Karg * @date May 2022 - * @section LICENSE - * - * Copyright (C) 2022 Steve Karg - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #ifndef BACNET_HOST_N_PORT_H #define BACNET_HOST_N_PORT_H diff --git a/src/bacnet/iam.c b/src/bacnet/iam.c index b75aebe6..3dc0948a 100644 --- a/src/bacnet/iam.c +++ b/src/bacnet/iam.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2005 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief I-Have service encode and decode helper functions + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" @@ -40,8 +14,6 @@ #include "bacnet/bacdcode.h" #include "bacnet/iam.h" -/** @file iam.c Encode/Decode I-Am service */ - /** * @brief Encode the I-Am service. * diff --git a/src/bacnet/iam.h b/src/bacnet/iam.h index 9ecee2b0..f3aef255 100644 --- a/src/bacnet/iam.h +++ b/src/bacnet/iam.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef IAM_H -#define IAM_H +/** + * @file + * @brief API for I-Am service encode and decode + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_I_AM_H +#define BACNET_I_AM_H #include #include diff --git a/src/bacnet/ihave.c b/src/bacnet/ihave.c index a45d40d4..092eecbe 100644 --- a/src/bacnet/ihave.c +++ b/src/bacnet/ihave.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2006 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief API for I-Have service encode and decode + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" @@ -38,8 +12,6 @@ #include "bacnet/bacdcode.h" #include "bacnet/ihave.h" -/** @file ihave.c Encode/Decode I-Have service */ - /** * Encode the I Have request * diff --git a/src/bacnet/ihave.h b/src/bacnet/ihave.h index d4d22489..5ac7c121 100644 --- a/src/bacnet/ihave.h +++ b/src/bacnet/ihave.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef IHAVE_H -#define IHAVE_H +/** + * @file + * @brief API for I-Have service encode and decode + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_I_HAVE_H +#define BACNET_I_HAVE_H #include #include diff --git a/src/bacnet/indtext.c b/src/bacnet/indtext.c index f132bf23..78105fa8 100644 --- a/src/bacnet/indtext.c +++ b/src/bacnet/indtext.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2005 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief API for index and text pairs lookup functions + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include #include diff --git a/src/bacnet/indtext.h b/src/bacnet/indtext.h index b24541a5..4a1a023e 100644 --- a/src/bacnet/indtext.h +++ b/src/bacnet/indtext.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef INDTEXT_H -#define INDTEXT_H +/** + * @file + * @brief API for index and text pairs lookup functions + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_INDEX_TEXT_H +#define BACNET_INDEX_TEXT_H #include #include diff --git a/src/bacnet/lighting.c b/src/bacnet/lighting.c index 98f63b47..27532131 100644 --- a/src/bacnet/lighting.c +++ b/src/bacnet/lighting.c @@ -3,11 +3,7 @@ * @brief API for BACnetLightingCommand and BACnetColorCommand * @author Steve Karg * @date June 2022 - * @section LICENSE - * - * Copyright (C) 2022 Steve Karg - * - * SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 */ #include #include diff --git a/src/bacnet/lighting.h b/src/bacnet/lighting.h index 81efe9b9..ab9fb02b 100644 --- a/src/bacnet/lighting.h +++ b/src/bacnet/lighting.h @@ -3,15 +3,10 @@ * @brief API for BACnetLightingCommand and BACnetColorCommand * @author Steve Karg * @date June 2022 - * @section LICENSE - * - * Copyright (C) 2022 Steve Karg - * - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ -#ifndef LIGHTING_H -#define LIGHTING_H +#ifndef BACNET_LIGHTING_H +#define BACNET_LIGHTING_H #include #include diff --git a/src/bacnet/list_element.c b/src/bacnet/list_element.c index 805ebce3..d33fbfad 100644 --- a/src/bacnet/list_element.c +++ b/src/bacnet/list_element.c @@ -3,11 +3,7 @@ * @brief AddListElement and RemoveListElement service encode and decode * @author Steve Karg * @date December 2022 - * @section LICENSE - * - * Copyright (C) 2022 Steve Karg - * - * SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 */ #include #include diff --git a/src/bacnet/list_element.h b/src/bacnet/list_element.h index d4160c90..19e8b830 100644 --- a/src/bacnet/list_element.h +++ b/src/bacnet/list_element.h @@ -3,11 +3,7 @@ * @brief API for AddListElement and RemoveListElement service codec * @author Steve Karg * @date December 2022 - * @section LICENSE - * - * Copyright (C) 2022 Steve Karg - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #ifndef BACNET_LIST_ELEMENT_H #define BACNET_LIST_ELEMENT_H diff --git a/src/bacnet/lso.c b/src/bacnet/lso.c index fe44ab66..33738d34 100644 --- a/src/bacnet/lso.c +++ b/src/bacnet/lso.c @@ -1,43 +1,16 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2008 John Minack - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief API for BACnetLifeSafetyOperation encoder and decoder + * @author John Minack + * @author Steve Karg + * @date 2008 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include "bacnet/lso.h" #include "bacnet/bacdcode.h" #include "bacnet/apdu.h" -/** @file lso.c BACnet Life Safety Operation encode/decode */ - /** * @brief Encode APDU for LifeSafetyOperation-Request * @param apdu Pointer to the buffer, or NULL for length diff --git a/src/bacnet/lso.h b/src/bacnet/lso.h index 537c1cd3..a225618d 100644 --- a/src/bacnet/lso.h +++ b/src/bacnet/lso.h @@ -1,28 +1,13 @@ -/************************************************************************** -* -* Copyright (C) 2006 John Minack -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef LSO_H -#define LSO_H +/** + * @file + * @brief API for BACnetLifeSafetyOperation encoder and decoder + * @author John Minack + * @author Steve Karg + * @date 2008 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_LIFE_SAFETY_OPERATION_H +#define BACNET_LIFE_SAFETY_OPERATION_H #include #include diff --git a/src/bacnet/memcopy.c b/src/bacnet/memcopy.c index 79862cc2..86b99de6 100644 --- a/src/bacnet/memcopy.c +++ b/src/bacnet/memcopy.c @@ -1,38 +1,9 @@ /** * @file - * @author Steve Karg + * @brief API for memory copy function + * @author Steve Karg * @date 2008 - * @section LICENSE - * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to: - * The Free Software Foundation, Inc. - * 59 Temple Place - Suite 330 - * Boston, MA 02111-1307 - * USA. - * - * As a special exception, if other files instantiate templates or - * use macros or inline functions from this file, or you compile - * this file and link it with other works to produce a work based - * on this file, this file does not by itself cause the resulting - * work to be covered by the GNU General Public License. However - * the source code for this file must still be made available in - * accordance with section (3) of the GNU General Public License. - * - * This exception does not invalidate any other reasons why a work - * based on this file might be covered by the GNU General Public - * License. - * + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 * @section DESCRIPTION * * Memory copy functions for deeply embedded system. The functions diff --git a/src/bacnet/memcopy.h b/src/bacnet/memcopy.h index a12594b6..6af16616 100644 --- a/src/bacnet/memcopy.h +++ b/src/bacnet/memcopy.h @@ -1,31 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef MEMCOPY_H -#define MEMCOPY_H - -/* Functional Description: Memory copy function */ - +/** + * @file + * @brief API for memory copy function + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_MEMCOPY_H +#define BACNET_MEMCOPY_H #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/npdu.c b/src/bacnet/npdu.c index e7978a04..6659d18f 100644 --- a/src/bacnet/npdu.c +++ b/src/bacnet/npdu.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2005 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief API for Network Protocol Data Unit (NPDU) encode and decode functions + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/npdu.h b/src/bacnet/npdu.h index 21bcc84d..0529ea91 100644 --- a/src/bacnet/npdu.h +++ b/src/bacnet/npdu.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef NPDU_H -#define NPDU_H +/** + * @file + * @brief API for Network Protocol Data Unit (NPDU) encode and decode functions + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_NPDU_H +#define BACNET_NPDU_H #include #include diff --git a/src/bacnet/property.c b/src/bacnet/property.c index 4e2ebfeb..b4774c29 100644 --- a/src/bacnet/property.c +++ b/src/bacnet/property.c @@ -3,11 +3,7 @@ * @brief Static sets of BACnet Property members for each object type * @author Steve Karg * @date 2012 - * @section LICENSE - * - * Copyright (C) 2012 Steve Karg - * - * SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 */ #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/property.h b/src/bacnet/property.h index 7e55f806..2cddc17c 100644 --- a/src/bacnet/property.h +++ b/src/bacnet/property.h @@ -1,13 +1,9 @@ /** * @file - * @brief Static sets of BACnet Property members for each object type + * @brief Library of all required and optional object properties * @author Steve Karg * @date 2012 - * @section LICENSE - * - * Copyright (C) 2012 Steve Karg - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #ifndef BACNET_PROPERTY_H #define BACNET_PROPERTY_H @@ -20,8 +16,6 @@ #include "bacnet/rp.h" #include "bacnet/proplist.h" -/** @file property.h Library of all required and optional object properties */ - #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ diff --git a/src/bacnet/proplist.c b/src/bacnet/proplist.c index 90edd569..f5951909 100644 --- a/src/bacnet/proplist.c +++ b/src/bacnet/proplist.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2012 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief Property_List property encode decode helper + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" diff --git a/src/bacnet/proplist.h b/src/bacnet/proplist.h index fea9f683..12f4517f 100644 --- a/src/bacnet/proplist.h +++ b/src/bacnet/proplist.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef PROPLIST_H -#define PROPLIST_H +/** + * @file + * @brief Property_List property encode decode helper + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_PROPLIST_H +#define BACNET_PROPLIST_H #include #include @@ -31,7 +15,6 @@ /* BACnet Stack API */ #include "bacnet/rp.h" -/** @file Property_List property encode decode helper */ struct property_list_t { const int *pList; unsigned count; diff --git a/src/bacnet/ptransfer.c b/src/bacnet/ptransfer.c index 841e0d9d..79e11811 100644 --- a/src/bacnet/ptransfer.c +++ b/src/bacnet/ptransfer.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2009 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet PrivateTransfer encode and decode helper functions + * @author Steve Karg + * @date 2009 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" @@ -38,8 +12,6 @@ #include "bacnet/bacdcode.h" #include "bacnet/ptransfer.h" -/** @file ptransfer.c Encode/Decode Private Transfer data */ - /* encode service */ static int pt_encode_apdu(uint8_t *apdu, uint16_t max_apdu, diff --git a/src/bacnet/ptransfer.h b/src/bacnet/ptransfer.h index 284f08fb..66dd3fa6 100644 --- a/src/bacnet/ptransfer.h +++ b/src/bacnet/ptransfer.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef PRIVATE_TRANSFER_H -#define PRIVATE_TRANSFER_H +/** + * @file + * @brief BACnet PrivateTransfer encode and decode helper functions + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_PRIVATE_TRANSFER_H +#define BACNET_PRIVATE_TRANSFER_H #include #include diff --git a/src/bacnet/rd.c b/src/bacnet/rd.c index f9bb9a43..0926e077 100644 --- a/src/bacnet/rd.c +++ b/src/bacnet/rd.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2005 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet ReinitializeDevice-Request encode and decode helper functions + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" @@ -38,7 +12,6 @@ #include "bacnet/bacdcode.h" #include "bacnet/rd.h" -/** @file rd.c Encode/Decode Reinitialize Device APDUs */ #if BACNET_SVC_RD_A /** * @brief Encode ReinitializeDevice-Request APDU diff --git a/src/bacnet/rd.h b/src/bacnet/rd.h index b21140e8..964459ad 100644 --- a/src/bacnet/rd.h +++ b/src/bacnet/rd.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef REINITIALIZE_DEVICE_H -#define REINITIALIZE_DEVICE_H +/** + * @file + * @brief BACnet ReinitializeDevice encode and decode helper functions + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_REINITIALIZE_DEVICE_H +#define BACNET_REINITIALIZE_DEVICE_H #include #include diff --git a/src/bacnet/readrange.c b/src/bacnet/readrange.c index bc33a773..1eeb180f 100644 --- a/src/bacnet/readrange.c +++ b/src/bacnet/readrange.c @@ -1,36 +1,11 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2009 Peter Mc Shane - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet ReadRange-Request encode and decode helper functions + * @author Peter Mc Shane + * @author Steve Karg + * @date 2009 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" @@ -38,8 +13,6 @@ #include "bacnet/bacdcode.h" #include "bacnet/readrange.h" -/** @file readrange.c Encode/Decode ReadRange requests */ - /* * ReadRange-Request ::= SEQUENCE { * objectIdentifier [0] BACnetObjectIdentifier, diff --git a/src/bacnet/readrange.h b/src/bacnet/readrange.h index 2802a4b9..75ffd5d2 100644 --- a/src/bacnet/readrange.h +++ b/src/bacnet/readrange.h @@ -1,28 +1,13 @@ -/************************************************************************** -* -* Copyright (C) 2009 Peter Mc Shane -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef READRANGE_H -#define READRANGE_H +/** + * @file + * @brief BACnet ReadRange encode and decode helper functions + * @author Peter Mc Shane + * @author Steve Karg + * @date 2009 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_READ_RANGE_H +#define BACNET_READ_RANGE_H /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" /* BACnet Stack API */ @@ -80,9 +65,9 @@ extern "C" { * - 1. PDU Type + invoke ID + service type = 3 bytes * - 2. Object ID = 5 bytes * - 3. Object Property = 2 bytes if property is 0-255, 3 if property is - * 256-65535 � theoretical max of 5 bytes but how likely is that? + * 256-65535 theoretical max of 5 bytes but how likely is that? * - 4. Optional array index = 2 bytes if index is 0-255, 3 if index is - * 256-65535 � theoretical max of 5 bytes but how likely is that? + * 256-65535 theoretical max of 5 bytes but how likely is that? * - 5. Flags = 3 bytes * - 6. Opening and closing tag for data = 2 bytes * - 7. firstSequenceNumber [6] Unsigned32 OPTIONAL -- used only if 'Item Count' > 0 diff --git a/src/bacnet/reject.c b/src/bacnet/reject.c index 08186f67..27560ef0 100644 --- a/src/bacnet/reject.c +++ b/src/bacnet/reject.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2005 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet Reject message encode and decode helper functions + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" @@ -38,8 +12,6 @@ #include "bacnet/bacdcode.h" #include "bacnet/reject.h" -/** @file reject.c Encode/Decode Reject APDUs */ - /** * @brief Convert an error code BACnet Reject code * @param error_code - value to be converted diff --git a/src/bacnet/reject.h b/src/bacnet/reject.h index 233cbacf..4b4f4ff9 100644 --- a/src/bacnet/reject.h +++ b/src/bacnet/reject.h @@ -1,26 +1,10 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ +/** + * @file + * @brief BACnet Reject message encode and decode helper functions + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ #ifndef BACNET_REJECT_H #define BACNET_REJECT_H diff --git a/src/bacnet/rp.c b/src/bacnet/rp.c index 91aabf2c..1da004b4 100644 --- a/src/bacnet/rp.c +++ b/src/bacnet/rp.c @@ -1,36 +1,11 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2005 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet ReadProperty-Request and ReadProperty-ACK encode and decode + * helper functions + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" @@ -38,8 +13,6 @@ #include "bacnet/bacdcode.h" #include "bacnet/rp.h" -/** @file rp.c Encode/Decode Read Property and RP ACKs */ - #if BACNET_SVC_RP_A /** * @brief Encode APDU for ReadProperty-Request diff --git a/src/bacnet/rp.h b/src/bacnet/rp.h index 9a066db2..73c04cd7 100644 --- a/src/bacnet/rp.h +++ b/src/bacnet/rp.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef READPROPERTY_H -#define READPROPERTY_H +/** + * @file + * @brief BACnet ReadProperty-Request encode and decode helper functions + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_READ_PROPERTY_H +#define BACNET_READ_PROPERTY_H #include #include diff --git a/src/bacnet/special_event.c b/src/bacnet/special_event.c index c82c9ea4..1acdbe6a 100644 --- a/src/bacnet/special_event.c +++ b/src/bacnet/special_event.c @@ -6,7 +6,6 @@ * @date May 2022 * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 */ - #include #include "bacnet/special_event.h" #include "bacnet/bacdcode.h" diff --git a/src/bacnet/special_event.h b/src/bacnet/special_event.h index 3d8587de..9c84f704 100644 --- a/src/bacnet/special_event.h +++ b/src/bacnet/special_event.h @@ -4,9 +4,7 @@ * @author Ondřej Hruška * @author Steve Karg * @date August 2023 - * @section LICENSE - * - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ #ifndef BACNET_SPECIAL_EVENT_H #define BACNET_SPECIAL_EVENT_H diff --git a/src/bacnet/timestamp.h b/src/bacnet/timestamp.h index bfa1e815..9f7ff4ae 100644 --- a/src/bacnet/timestamp.h +++ b/src/bacnet/timestamp.h @@ -1,28 +1,13 @@ -/************************************************************************** -* -* Copyright (C) 2008 John Minack -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef _TIMESTAMP_H_ -#define _TIMESTAMP_H_ +/** + * @file + * @brief API for BACnetTimestamp encode and decode helper functions + * @author John Minack + * @author Steve Karg + * @date 2008 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_TIMESTAMP_H_ +#define BACNET_TIMESTAMP_H_ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" diff --git a/src/bacnet/timesync.c b/src/bacnet/timesync.c index 47ed7e54..ff9ffbc8 100644 --- a/src/bacnet/timesync.c +++ b/src/bacnet/timesync.c @@ -1,36 +1,11 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2006 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet TimeSyncronization service and BACnetRecipientList data + * encoder and decoder + * @author Steve Karg + * @date 2006 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" @@ -39,7 +14,6 @@ #include "bacnet/bacapp.h" #include "bacnet/timesync.h" -/** @file timesync.c Encode/Decode TimeSync APDUs */ #if BACNET_SVC_TS_A /** Encode the time synchronisation service. * diff --git a/src/bacnet/timesync.h b/src/bacnet/timesync.h index 76d6cf15..79f9f6ed 100644 --- a/src/bacnet/timesync.h +++ b/src/bacnet/timesync.h @@ -1,28 +1,13 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef TIMESYNC_H -#define TIMESYNC_H +/** + * @file + * @brief API for BACnet TimeSyncronization service and BACnetRecipientList + * encoder and decoder + * @author Steve Karg + * @date 2012 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_TIMESYNC_H +#define BACNET_TIMESYNC_H #include #include diff --git a/src/bacnet/version.h b/src/bacnet/version.h index 2d04bbd7..f6cdcad7 100644 --- a/src/bacnet/version.h +++ b/src/bacnet/version.h @@ -3,12 +3,10 @@ * @author Steve Karg * @date 2004 * @brief BACnet protocol stack version 0.0.0 - 255.255.255 - * @copyright - * Copyright (C) 2004 Steve Karg - * SPDX-License-Identifier: MIT + * @copyright SPDX-License-Identifier: MIT */ -#ifndef _BACNET_VERSION_H_ -#define _BACNET_VERSION_H_ +#ifndef BACNET_VERSION_H_ +#define BACNET_VERSION_H_ /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" diff --git a/src/bacnet/whois.c b/src/bacnet/whois.c index 4c8c52a3..2b131a06 100644 --- a/src/bacnet/whois.c +++ b/src/bacnet/whois.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2005 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief Encode/Decode Who-Is requests + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include /* BACnet Stack defines - first */ #include "bacnet/bacdef.h" @@ -38,8 +12,6 @@ #include "bacnet/bacdcode.h" #include "bacnet/whois.h" -/** @file whois.c Encode/Decode Who-Is requests */ - /* encode I-Am service - use -1 for limit if you want unlimited */ int whois_encode_apdu(uint8_t *apdu, int32_t low_limit, int32_t high_limit) { diff --git a/src/bacnet/whois.h b/src/bacnet/whois.h index b25f39e8..77e82e17 100644 --- a/src/bacnet/whois.h +++ b/src/bacnet/whois.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef WHOIS_H -#define WHOIS_H +/** + * @file + * @brief API for BACnet Who-Is service encoder and decoder + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_WHOIS_H +#define BACNET_WHOIS_H #include #include diff --git a/src/bacnet/wp.c b/src/bacnet/wp.c index 771fc3aa..143c7a4e 100644 --- a/src/bacnet/wp.c +++ b/src/bacnet/wp.c @@ -1,36 +1,10 @@ -/*####COPYRIGHTBEGIN#### - ------------------------------------------- - Copyright (C) 2005 Steve Karg - - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License - as published by the Free Software Foundation; either version 2 - of the License, or (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to: - The Free Software Foundation, Inc. - 59 Temple Place - Suite 330 - Boston, MA 02111-1307, USA. - - As a special exception, if other files instantiate templates or - use macros or inline functions from this file, or you compile - this file and link it with other works to produce a work based - on this file, this file does not by itself cause the resulting - work to be covered by the GNU General Public License. However - the source code for this file must still be made available in - accordance with section (3) of the GNU General Public License. - - This exception does not invalidate any other reasons why a work - based on this file might be covered by the GNU General Public - License. - ------------------------------------------- -####COPYRIGHTEND####*/ +/** + * @file + * @brief BACnet WriteProperty service encoder and decoder + * @author Steve Karg + * @date 2005 + * @copyright SPDX-License-Identifier: GPL-2.0-or-later WITH GCC-exception-2.0 + */ #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/wp.h b/src/bacnet/wp.h index 29a5c914..ce0894b9 100644 --- a/src/bacnet/wp.h +++ b/src/bacnet/wp.h @@ -1,28 +1,12 @@ -/************************************************************************** -* -* Copyright (C) 2012 Steve Karg -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -*********************************************************************/ -#ifndef WRITEPROPERTY_H -#define WRITEPROPERTY_H +/** + * @file + * @brief API for BACnet WriteProperty service encoder and decoder + * @author Steve Karg + * @date 2004 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_WRITE_PROPERTY_H +#define BACNET_WRITE_PROPERTY_H #include #include diff --git a/src/bacnet/wpm.c b/src/bacnet/wpm.c index 08e3314d..327f2b46 100644 --- a/src/bacnet/wpm.c +++ b/src/bacnet/wpm.c @@ -1,28 +1,12 @@ -/************************************************************************** - * - * Copyright (C) 2011 Krzysztof Malorny - * Contributions by Nikola Jelic 2011 - * - * Permission is hereby granted, free of charge, to any person obtaining - * a copy of this software and associated documentation files (the - * "Software"), to deal in the Software without restriction, including - * without limitation the rights to use, copy, modify, merge, publish, - * distribute, sublicense, and/or sell copies of the Software, and to - * permit persons to whom the Software is furnished to do so, subject to - * the following conditions: - * - * The above copyright notice and this permission notice shall be included - * in all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF - * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. - * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY - * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, - * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE - * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - * - *********************************************************************/ +/** + * @file + * @brief API for BACnet WritePropertyMultiple service encoder and decoder + * @author Krzysztof Malorny + * @author Nikola Jelic 2011 + * @author Steve Karg + * @date 2011 + * @copyright SPDX-License-Identifier: MIT + */ #include #include /* BACnet Stack defines - first */ diff --git a/src/bacnet/wpm.h b/src/bacnet/wpm.h index b8feea7e..a1326f10 100644 --- a/src/bacnet/wpm.h +++ b/src/bacnet/wpm.h @@ -1,29 +1,13 @@ -/************************************************************************** -* -* Copyright (C) 2011 Krzysztof Malorny -* -* Permission is hereby granted, free of charge, to any person obtaining -* a copy of this software and associated documentation files (the -* "Software"), to deal in the Software without restriction, including -* without limitation the rights to use, copy, modify, merge, publish, -* distribute, sublicense, and/or sell copies of the Software, and to -* permit persons to whom the Software is furnished to do so, subject to -* the following conditions: -* -* The above copyright notice and this permission notice shall be included -* in all copies or substantial portions of the Software. -* -* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -* -*********************************************************************/ -#ifndef WRITEPROPERTYMULTIPLE_H -#define WRITEPROPERTYMULTIPLE_H +/** + * @file + * @brief API for BACnet WritePropertyMultiple service encoder and decoder + * @author Krzysztof Malorny + * @author Steve Karg + * @date 2011 + * @copyright SPDX-License-Identifier: MIT + */ +#ifndef BACNET_WRITE_PROPERTY_MULTIPLE_H +#define BACNET_WRITE_PROPERTY_MULTIPLE_H #include #include