Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ensure all core code has standard header and consistent guard naming #1630

Merged
merged 1 commit into from
Feb 19, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Sming/SmingCore/ArduinoCompat.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* http://github.com/anakod/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* Arduino Compatibility Layer
* ArduinoCompact.cpp - Arduino Compatibility Layer
*
* @author: 2017 - Slavey Karadzhov <slav@attachix.com>
*
Expand Down
8 changes: 4 additions & 4 deletions Sming/SmingCore/ArduinoCompat.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
* http://github.com/anakod/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* Arduino Compatibility Layer
* ArduinoCompat.h - Arduino Compatibility Layer
*
* @author: 2017 - Slavey Karadzhov <slav@attachix.com>
*
****/

#ifndef SMINGCORE_ARDUINOCOMPAT_H_
#define SMINGCORE_ARDUINOCOMPAT_H_
#ifndef _SMING_CORE_ARDUINO_COMPAT_H_
#define _SMING_CORE_ARDUINO_COMPAT_H_

#include "SmingCore.h"
#include <stdio.h> ///< sprintf()
Expand All @@ -29,4 +29,4 @@ void yield();
}
#endif

#endif /* SMINGCORE_ARDUINOCOMPAT_H_ */
#endif /* _SMING_CORE_ARDUINO_COMPAT_H_ */
10 changes: 8 additions & 2 deletions Sming/SmingCore/AtClient.cpp
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
/*
/****
* Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
* Created 2015 by Skurydin Alexey
* http://github.com/anakod/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* AtClient.cpp
*
* Created on: Feb 23, 2017
* Author: slavey
*/
*
****/

#include "AtClient.h"
#include "Clock.h"
Expand Down
3 changes: 3 additions & 0 deletions Sming/SmingCore/AtClient.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
* Created 2017 by Slavey Karadzhov
* http://github.com/anakod/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* AtClient.h
*
****/

/** @defgroup serial AtCommand serial
Expand Down
3 changes: 3 additions & 0 deletions Sming/SmingCore/Clock.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
* Created 2015 by Skurydin Alexey
* http://github.com/anakod/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* Clock.cpp
*
****/

#include "Clock.h"
Expand Down
4 changes: 4 additions & 0 deletions Sming/SmingCore/Clock.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@
* Created 2015 by Skurydin Alexey
* http://github.com/anakod/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* Clock.h
*
****/

/** @defgroup timedelay Time and Delay
* @brief Provides time and delay functions
* @ingroup datetime
Expand Down
2 changes: 2 additions & 0 deletions Sming/SmingCore/Data/CStringArray.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
* http://github.com/SmingHub/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* CStringArray.cpp
*
* @author: 2018 - Mikee47 <mike@sillyhouse.net>
*
****/
Expand Down
8 changes: 5 additions & 3 deletions Sming/SmingCore/Data/CStringArray.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@
* http://github.com/SmingHub/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* CStringArray.h
*
* @author: 2018 - Mikee47 <mike@sillyhouse.net>
*
****/

#ifndef _SMING_CORE_DATA_STRING_ARRAY_H_
#define _SMING_CORE_DATA_STRING_ARRAY_H_
#ifndef _SMING_CORE_DATA_C_STRING_ARRAY_H_
#define _SMING_CORE_DATA_C_STRING_ARRAY_H_

#include "WString.h"

Expand Down Expand Up @@ -119,4 +121,4 @@ class CStringArray : protected String
mutable unsigned stringCount = 0;
};

#endif // _SMING_CORE_DATA_STRING_ARRAY_H_
#endif // _SMING_CORE_DATA_C_STRING_ARRAY_H_
2 changes: 2 additions & 0 deletions Sming/SmingCore/Data/CircularBuffer.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
* http://github.com/SmingHub/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* CircularBuffer.cpp
*
* Initial code done by Ivan Grokhotkov as part of the esp8266 core for Arduino environment.
* https://github.com/esp8266/Arduino/blob/master/cores/esp8266/cbuf.h
*
Expand Down
2 changes: 2 additions & 0 deletions Sming/SmingCore/Data/CircularBuffer.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
* http://github.com/SmingHub/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* CircularBuffer.h
*
* Initial code done by Ivan Grokhotkov as part of the esp8266 core for Arduino environment.
* https://github.com/esp8266/Arduino/blob/master/cores/esp8266/cbuf.h
*
Expand Down
2 changes: 2 additions & 0 deletions Sming/SmingCore/Data/HexString.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
* http://github.com/SmingHub/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* HexString.cpp
*
*/

#include "HexString.h"
Expand Down
9 changes: 5 additions & 4 deletions Sming/SmingCore/Data/HexString.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@
* http://github.com/SmingHub/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* HexString.h - Utility functions to deal with hex-encoded strings
*
* @author: 2018 - Mikee47 <mike@sillyhouse.net>
*
* Utility functions to deal with hex-encoded strings
*/

#ifndef _HEX_STRING_H_
#define _HEX_STRING_H_
#ifndef _SMING_CORE_DATA_HEX_STRING_H_
#define _SMING_CORE_DATA_HEX_STRING_H_

#include "WString.h"

Expand All @@ -22,4 +23,4 @@
*/
String makeHexString(const uint8_t* data, unsigned length, char separator = '\0');

#endif // _HEX_STRING_H_
#endif /* _SMING_CORE_DATA_HEX_STRING_H_ */
2 changes: 2 additions & 0 deletions Sming/SmingCore/Data/MailMessage.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
* http://github.com/SmingHub/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* MailMessage.cpp
*
* @author Slavey Karadzhov <slaff@attachix.com>
*
****/
Expand Down
15 changes: 8 additions & 7 deletions Sming/SmingCore/Data/MailMessage.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
* http://github.com/SmingHub/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* MailMessage.h
*
* @author Slavey Karadzhov <slaff@attachix.com>
*
****/
Expand All @@ -14,13 +16,12 @@
* @{
*/

#ifndef _SMING_CORE_DATA_MESSAGE_H_
#define _SMING_CORE_DATA_MESSAGE_H_

#include "../../Wiring/WString.h"
#include "../../Wiring/WVector.h"
#include "../Network/WebConstants.h"
#ifndef _SMING_CORE_DATA_MAIL_MESSAGE_H_
#define _SMING_CORE_DATA_MAIL_MESSAGE_H_

#include "WString.h"
#include "WVector.h"
#include "Network/WebConstants.h"
#include "Network/Http/HttpHeaders.h"
#include "Stream/MultipartStream.h"
#include "Stream/DataSourceStream.h"
Expand Down Expand Up @@ -78,4 +79,4 @@ class MailMessage
};

/** @} */
#endif /* _SMING_CORE_DATA_MESSAGE_H_ */
#endif /* _SMING_CORE_DATA_MAIL_MESSAGE_H_ */
2 changes: 2 additions & 0 deletions Sming/SmingCore/Data/ObjectQueue.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
* http://github.com/SmingHub/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* ObjectQueue.h
*
* @author Slavey Karadzhov <slaff@attachix.com>
*
* @author: 12 Aug 2018 - Mikee47 <mike@sillyhouse.net>
Expand Down
2 changes: 2 additions & 0 deletions Sming/SmingCore/Data/Stream/Base64OutputStream.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
* http://github.com/SmingHub/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* Base64OutputStream.cpp
*
* @author Slavey Karadzhov <slaff@attachix.com>
*
****/
Expand Down
8 changes: 5 additions & 3 deletions Sming/SmingCore/Data/Stream/Base64OutputStream.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@
* http://github.com/SmingHub/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* Base64OutputStream.h
*
* @author Slavey Karadzhov <slaff@attachix.com>
*
****/

#ifndef _SMING_CORE_DATA_BASE64_OUTPUT_STREAM_H_
#define _SMING_CORE_DATA_BASE64_OUTPUT_STREAM_H_
#ifndef _SMING_CORE_DATA_STREAM_BASE64_OUTPUT_STREAM_H_
#define _SMING_CORE_DATA_STREAM_BASE64_OUTPUT_STREAM_H_

#include "../StreamTransformer.h"
#include "../Services/libb64/cencode.h"
Expand Down Expand Up @@ -49,4 +51,4 @@ class Base64OutputStream : public StreamTransformer
};

/** @} */
#endif /* _SMING_CORE_DATA_BASE64_OUTPUT_STREAM_H_ */
#endif /* _SMING_CORE_DATA_STREAM_BASE64_OUTPUT_STREAM_H_ */
2 changes: 2 additions & 0 deletions Sming/SmingCore/Data/Stream/ChunkedStream.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
* http://github.com/SmingHub/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* ChunkedStream.cpp
*
* @author Slavey Karadzhov <slaff@attachix.com>
*
****/
Expand Down
8 changes: 5 additions & 3 deletions Sming/SmingCore/Data/Stream/ChunkedStream.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@
* http://github.com/SmingHub/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* ChunkedStream.h
*
* @author Slavey Karadzhov <slaff@attachix.com>
*
****/

#ifndef _SMING_CORE_DATA_CHUNKED_STREAM_H_
#define _SMING_CORE_DATA_CHUNKED_STREAM_H_
#ifndef _SMING_CORE_DATA_STREAM_CHUNKED_STREAM_H_
#define _SMING_CORE_DATA_STREAM_CHUNKED_STREAM_H_

#include "../StreamTransformer.h"

Expand All @@ -30,4 +32,4 @@ class ChunkedStream : public StreamTransformer
};

/** @} */
#endif /* _SMING_CORE_DATA_CHUNKED_STREAM_H_ */
#endif /* _SMING_CORE_DATA_STREAM_CHUNKED_STREAM_H_ */
3 changes: 3 additions & 0 deletions Sming/SmingCore/Data/Stream/DataSourceStream.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
* Created 2015 by Skurydin Alexey
* http://github.com/anakod/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* DataSourceStream.cpp
*
****/

#include "DataSourceStream.h"
Expand Down
9 changes: 6 additions & 3 deletions Sming/SmingCore/Data/Stream/DataSourceStream.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@
* Created 2015 by Skurydin Alexey
* http://github.com/anakod/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* DataSourceStream.h
*
****/

#ifndef _SMING_CORE_DATA_DATA_SOURCE_STREAM_H_
#define _SMING_CORE_DATA_DATA_SOURCE_STREAM_H_
#ifndef _SMING_CORE_DATA_STREAM_DATA_SOURCE_STREAM_H_
#define _SMING_CORE_DATA_STREAM_DATA_SOURCE_STREAM_H_

#include <user_config.h>
#include "Stream.h"
Expand Down Expand Up @@ -141,4 +144,4 @@ class IDataSourceStream : public Stream
};

/** @} */
#endif /* _SMING_CORE_DATA_DATA_SOURCE_STREAM_H_ */
#endif /* _SMING_CORE_DATA_STREAM_DATA_SOURCE_STREAM_H_ */
3 changes: 3 additions & 0 deletions Sming/SmingCore/Data/Stream/EndlessMemoryStream.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
* Created 2015 by Skurydin Alexey
* http://github.com/anakod/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* EndlessMemoryStream.cpp
*
****/

#include "EndlessMemoryStream.h"
Expand Down
9 changes: 6 additions & 3 deletions Sming/SmingCore/Data/Stream/EndlessMemoryStream.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@
* Created 2015 by Skurydin Alexey
* http://github.com/anakod/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* EndlessMemoryStream.h
*
****/

#ifndef _SMING_CORE_ENDLESS_MEMORY_STREAM_H_
#define _SMING_CORE_ENDLESS_MEMORY_STREAM_H_
#ifndef _SMING_CORE_DATA_STREAM_ENDLESS_MEMORY_STREAM_H_
#define _SMING_CORE_DATA_STREAM_ENDLESS_MEMORY_STREAM_H_

#include "MemoryDataStream.h"

Expand Down Expand Up @@ -59,4 +62,4 @@ class EndlessMemoryStream : public ReadWriteStream
};

/** @} */
#endif /* _SMING_CORE_ENDLESS_MEMORY_STREAM_H_ */
#endif /* _SMING_CORE_DATA_STREAM_ENDLESS_MEMORY_STREAM_H_ */
3 changes: 3 additions & 0 deletions Sming/SmingCore/Data/Stream/FileStream.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
* Created 2015 by Skurydin Alexey
* http://github.com/anakod/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* FileStream.cpp
*
****/

#include "FileStream.h"
Expand Down
3 changes: 3 additions & 0 deletions Sming/SmingCore/Data/Stream/FileStream.h
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
* Created 2015 by Skurydin Alexey
* http://github.com/anakod/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* FileStream.h
*
****/

#ifndef _SMING_CORE_DATA_FILE_STREAM_H_
Expand Down
2 changes: 2 additions & 0 deletions Sming/SmingCore/Data/Stream/FlashMemoryStream.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
* http://github.com/anakod/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* FlashMemoryStream.cpp
*
* @author: 23 Oct 2018 - mikee47 <mike@sillyhouse.net>
*
****/
Expand Down
8 changes: 5 additions & 3 deletions Sming/SmingCore/Data/Stream/FlashMemoryStream.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@
* http://github.com/anakod/Sming
* All files of the Sming Core are provided under the LGPL v3 license.
*
* FlashMemoryStream.h
*
* @author: 23 Oct 2018 - mikee47 <mike@sillyhouse.net>
*
****/

#ifndef _SMING_CORE_DATA_FLASH_MEMORY_STREAM_H_
#define _SMING_CORE_DATA_FLASH_MEMORY_STREAM_H_
#ifndef _SMING_CORE_DATA_STREAM_FLASH_MEMORY_STREAM_H_
#define _SMING_CORE_DATA_STREAM_FLASH_MEMORY_STREAM_H_

#include "DataSourceStream.h"

Expand Down Expand Up @@ -59,4 +61,4 @@ class FlashMemoryStream : public IDataSourceStream
};

/** @} */
#endif /* _SMING_CORE_DATA_FLASH_MEMORY_STREAM_H_ */
#endif /* _SMING_CORE_DATA_STREAM_FLASH_MEMORY_STREAM_H_ */
Loading