Skip to content

Add doxygen spellcheck job to Travis #8970

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

Merged
merged 1 commit into from
Jan 16, 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
22 changes: 21 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,27 @@ matrix:
after_success:
# Coverage for tools
- coveralls
# Report success since we have overridden default behaviour
# Report success since we have overridden default behavior
- bash -c "$STATUS" success "Local $NAME testing has passed"

- env:
- NAME=doxy-spellcheck

install:
- sudo apt-get install aspell

script:
# Run local testing on header file doxy
- ./tools/test/travis-ci/doxy-spellchecker/spell.sh drivers
- ./tools/test/travis-ci/doxy-spellchecker/spell.sh platform
- ./tools/test/travis-ci/doxy-spellchecker/spell.sh events
- ./tools/test/travis-ci/doxy-spellchecker/spell.sh rtos
- ./tools/test/travis-ci/doxy-spellchecker/spell.sh features/netsocket

after_success:
# Coverage for tools
- coveralls
# Report success since we have overridden default behavior
- bash -c "$STATUS" success "Local $NAME testing has passed"

# - <<: *tools-pytest
Expand Down
2 changes: 1 addition & 1 deletion drivers/MbedCRC.h
Original file line number Diff line number Diff line change
Expand Up @@ -497,7 +497,7 @@ class MbedCRC {
}

/** Constructor init called from all specialized cases of constructor.
* Note: All construtor common code should be in this function.
* Note: All constructor common code should be in this function.
*/
void mbed_crc_ctor(void)
{
Expand Down
6 changes: 3 additions & 3 deletions features/netsocket/L3IPInterface.h
Original file line number Diff line number Diff line change
Expand Up @@ -85,21 +85,21 @@ class L3IPInterface : public virtual NetworkInterface {
/** Get the local IP address
*
* @return Null-terminated representation of the local IP address
* or null if no IP address has been recieved
* or null if no IP address has been received
*/
virtual const char *get_ip_address();

/** Get the local network mask
*
* @return Null-terminated representation of the local network mask
* or null if no network mask has been recieved
* or null if no network mask has been received
*/
virtual const char *get_netmask();

/** Get the local gateways
*
* @return Null-terminated representation of the local gateway
* or null if no network mask has been recieved
* or null if no network mask has been received
*/
virtual const char *get_gateway();

Expand Down
4 changes: 2 additions & 2 deletions features/netsocket/TLSSocketWrapper.h
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ class TLSSocketWrapper : public Socket {
*/
void set_ssl_config(mbedtls_ssl_config *conf);

/** Get internal Mbed TLS contect structure.
/** Get internal Mbed TLS context structure.
* @return SSL context
*/
mbedtls_ssl_context *get_ssl_context();
Expand Down Expand Up @@ -198,7 +198,7 @@ class TLSSocketWrapper : public Socket {


private:
/** Continue already initialised handshake */
/** Continue already initialized handshake */
nsapi_error_t continue_handshake();
/**
* Helper for pretty-printing mbed TLS error codes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ class PPPCellularInterface : public CellularBase {
* connection. It doesn't do anything immediately other than setting up flags.
*
* @param set can be set to true if the SIM pin check is supposed to be enabled
* and vice versa.
* and false if not.
*/
MBED_DEPRECATED_SINCE("mbed-os-5.9", "This API will be deprecated, use mbed-os/features/cellular/easy_cellular/EasyCellularConnection.h instead.")
void set_sim_pin_check(bool set);
Expand Down
4 changes: 2 additions & 2 deletions platform/ATCmdParser.h
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
/**
* Allows traces from modem to be turned on or off
*
* @param on Set as 1 to turn on traces and vice versa.
* @param on Set as 1 to turn on traces and 0 to disable traces.
*/
void debug_on(uint8_t on)
{
Expand All @@ -184,7 +184,7 @@ class ATCmdParser : private NonCopyable<ATCmdParser> {
*
* Allows traces from modem to be turned on or off
*
* @param on Set as 1 to turn on traces and vice versa.
* @param on Set as 1 to turn on traces and 0 to disable traces.
*/
MBED_DEPRECATED_SINCE("mbed-os-5.5.0", "Replaced with debug_on for consistency")
void debugOn(uint8_t on)
Expand Down
4 changes: 2 additions & 2 deletions platform/mbed_critical.h
Original file line number Diff line number Diff line change
Expand Up @@ -93,14 +93,14 @@ bool core_util_in_critical_section(void);
* A lock-free, primitive atomic flag.
*
* Emulate C11's atomic_flag. The flag is initially in an indeterminate state
* unless explicitly initialised with CORE_UTIL_ATOMIC_FLAG_INIT.
* unless explicitly initialized with CORE_UTIL_ATOMIC_FLAG_INIT.
*/
typedef struct core_util_atomic_flag {
uint8_t _flag;
} core_util_atomic_flag;

/**
* Initialiser for a core_util_atomic_flag.
* Initializer for a core_util_atomic_flag.
*
* Example:
* ~~~
Expand Down
2 changes: 1 addition & 1 deletion platform/mbed_error.h
Original file line number Diff line number Diff line change
Expand Up @@ -948,7 +948,7 @@ typedef void (*mbed_error_hook_t)(const mbed_error_ctx *error_ctx);
* it will auto-reboot the system(if MBED_CONF_PLATFORM_FATAL_ERROR_AUTO_REBOOT_ENABLED is enabled) after capturing the
* error info in special crash data RAM region. Once rebooted, MbedOS initialization routines will call this function with a pointer to
* the captured mbed_error_ctx structure. If application implementation needs to receive this callback, mbed_error_reboot_callback
* function should be overriden with custom implementation. By default it's defined as a WEAK function in mbed_error.c.
* function should be overridden with custom implementation. By default it's defined as a WEAK function in mbed_error.c.
* Note that this callback will be invoked before the system starts executing main() function. So the implementation of
* the callback should be aware any resource limitations/availability of resources which are yet to be initialized by application main().
*
Expand Down
6 changes: 6 additions & 0 deletions tools/test/travis-ci/doxy-spellchecker/en.dat
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
name en
charset iso8859-1
soundslike en
affix en
special ' -*- 0 *** 1 *** 2 *** 3 *** 4 *** 5 *** 6 *** 7 *** 8 *** 9 *** < *** > *** _ ***
#repl-table en_affix.dat
226 changes: 226 additions & 0 deletions tools/test/travis-ci/doxy-spellchecker/en_affix.dat
Original file line number Diff line number Diff line change
@@ -0,0 +1,226 @@
#
# This affix file is based on Ispell, which is under the following
# copyright:
#
# Copyright 1992, 1993, 1999, 2000, 2001, Geoff Kuenning, Claremont, CA
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions, and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions, and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# 3. All modifications to the source code must be clearly marked as
# such. Binary redistributions based on modified source code
# must be clearly marked as modified versions in the documentation
# and/or other materials provided with the distribution.
# (Clause 4 removed with permission from Geoff Kuenning.)
# 5. The name of Geoff Kuenning may not be used to endorse or promote
# products derived from this software without specific prior
# written permission.
#
# THIS SOFTWARE IS PROVIDED BY GEOFF KUENNING AND CONTRIBUTORS 'AS IS' AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL GEOFF KUENNING OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
# SUCH DAMAGE.
#

SET ISO8859-1
TRY esianrtolcdugmphbyfvkwzESIANRTOLCDUGMPHBYFVKWZ'

PFX A Y 1
PFX A 0 re .

PFX I Y 1
PFX I 0 in .

PFX U Y 1
PFX U 0 un .

PFX C Y 1
PFX C 0 de .

PFX E Y 1
PFX E 0 dis .

PFX F Y 1
PFX F 0 con .

PFX K Y 1
PFX K 0 pro .

SFX V N 2
SFX V e ive e
SFX V 0 ive [^e]

SFX N Y 3
SFX N e ion e
SFX N y ication y
SFX N 0 en [^ey]

SFX X Y 3
SFX X e ions e
SFX X y ications y
SFX X 0 ens [^ey]

SFX H N 2
SFX H y ieth y
SFX H 0 th [^y]

SFX Y Y 1
SFX Y 0 ly .

SFX G Y 2
SFX G e ing e
SFX G 0 ing [^e]

SFX J Y 2
SFX J e ings e
SFX J 0 ings [^e]

SFX D Y 4
SFX D 0 d e
SFX D y ied [^aeiou]y
SFX D 0 ed [^ey]
SFX D 0 ed [aeiou]y

SFX T N 4
SFX T 0 st e
SFX T y iest [^aeiou]y
SFX T 0 est [aeiou]y
SFX T 0 est [^ey]

SFX R Y 4
SFX R 0 r e
SFX R y ier [^aeiou]y
SFX R 0 er [aeiou]y
SFX R 0 er [^ey]

SFX Z Y 4
SFX Z 0 rs e
SFX Z y iers [^aeiou]y
SFX Z 0 ers [aeiou]y
SFX Z 0 ers [^ey]

SFX S Y 4
SFX S y ies [^aeiou]y
SFX S 0 s [aeiou]y
SFX S 0 es [sxzh]
SFX S 0 s [^sxzhy]

SFX P Y 3
SFX P y iness [^aeiou]y
SFX P 0 ness [aeiou]y
SFX P 0 ness [^y]

SFX M Y 1
SFX M 0 's .

SFX B Y 3
SFX B 0 able [^aeiou]
SFX B 0 able ee
SFX B e able [^aeiou]e

SFX L Y 1
SFX L 0 ment .

REP 88
REP a ei
REP ei a
REP a ey
REP ey a
REP ai ie
REP ie ai
REP are air
REP are ear
REP are eir
REP air are
REP air ere
REP ere air
REP ere ear
REP ere eir
REP ear are
REP ear air
REP ear ere
REP eir are
REP eir ere
REP ch te
REP te ch
REP ch ti
REP ti ch
REP ch tu
REP tu ch
REP ch s
REP s ch
REP ch k
REP k ch
REP f ph
REP ph f
REP gh f
REP f gh
REP i igh
REP igh i
REP i uy
REP uy i
REP i ee
REP ee i
REP j di
REP di j
REP j gg
REP gg j
REP j ge
REP ge j
REP s ti
REP ti s
REP s ci
REP ci s
REP k cc
REP cc k
REP k qu
REP qu k
REP kw qu
REP o eau
REP eau o
REP o ew
REP ew o
REP oo ew
REP ew oo
REP ew ui
REP ui ew
REP oo ui
REP ui oo
REP ew u
REP u ew
REP oo u
REP u oo
REP u oe
REP oe u
REP u ieu
REP ieu u
REP ue ew
REP ew ue
REP uff ough
REP oo ieu
REP ieu oo
REP ier ear
REP ear ier
REP ear air
REP air ear
REP w qu
REP qu w
REP z ss
REP ss z
REP shun tion
REP shun sion
REP shun cion
Loading