events: Added note about immediate firing of periodic events

[geky]

Description

Added note about immediate firing of periodic events

see #6256
cc @pauluap, @kjbracey-arm

Pull request type

• Fix
• Refactor
• New target
• Feature
• Breaking change

[pauluap]

The Event class has no documentation :) But it's an very good note I think, alerts the reader that something's up and if they're sufficiently motivated, they can check on it themselves.

[geky]

Oh wow, there really isn't...

There is doxygen in the codebase, but for some reason it isn't generated. Will have to look into this:
https://github.com/ARMmbed/mbed-os/blob/master/events/Event.h#L1707

@AnotherButler, just fyi

[geky]

Also @AnotherButler quick question, when is doxygen updated on the developer site? Is it every minor release?

[pauluap]

aha, maybe not merged yet? - this is the location that the current mbeds docs site are looking at and the doc you pointed out doesn't exist in this one - https://os.mbed.com/docs/v5.7/mbed-os-api-doxy/classevents_1_1_event_3_01void_07_a0_00_01_a1_00_01_a2_00_01_a3_08_4.html (from clicking on "Event.h" - http://os.mbed.com/docs/v5.7/mbed-os-api-doxy/_event_8h_source.html on https://os.mbed.com/docs/v5.7/reference/event.html)

…

On Mon, Mar 5, 2018 at 9:45 AM, Christopher Haster ***@***.*** > wrote: Oh wow, there really isn't... There is doxygen in the codebase, but for some reason it isn't generated. Will have to look into this: https://github.com/ARMmbed/mbed-os/blob/master/events/Event.h#L1707 @AnotherButler <https://github.com/anotherbutler>, just fyi — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#6274 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAjCDnzkpKuCWtTTMAmtmDbgsZsFxNk6ks5tbXmvgaJpZM4Scp7V> .

[geky]

That's strange, it looks like all the comments were stripped out of the file? The Event.h file hasn't been touched in a long time (9 months)...

[cmonr]

@adbridge Thoughts to above?

[adbridge]

@geky @cmonr If there used to be doxygen style comments in the event.h header and they have been stripped out , we should track down when and why this was done and look to replace it.....

[cmonr]

/morph build

[cmonr]

The last PR that touched the header file: #4434

[cmonr]

On second glance, what's currently in the mbed repo looks fine. Wondering if the doc generation isn't capturing this/these files.

[mbed-ci]

Build : SUCCESS

Build number : 1363
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/6274/

Triggering tests

/morph test
/morph uvisor-test
/morph export-build
/morph mbed2-build

[mbed-ci]

Exporter Build : FAILURE

Build number : 1015
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/6274/

[mbed-ci]

Test : SUCCESS

Build number : 1143
Test logs :http://mbed-os-logs.s3-website-us-west-1.amazonaws.com/?prefix=logs/6274/1143

[cmonr]

Not restarting CI quite yet.

@studavekar What do you take of the export failure?

[studavekar]

Not restarting CI quite yet.

@studavekar What do you take of the export failure?

I am not sure, at least the failure look legit but in no way related to this change.

  158 000000a8                 END
0 Errors, 1 Warning
Error: L6200E: Symbol __asm___14_system_clock_c_a9c8fbbb____REV16 multiply defined (by mbed-os/targets/TARGET_STM/TARGET_STM32F0/device/stm32f0xx_hal_rcc_ex.o and mbed-os/targets/TARGET_STM/TARGET_STM32F0/TARGET_NUCLEO_F091RC/device/system_clock.o).
Error: L6200E: Symbol __asm___14_system_clock_c_a9c8fbbb____REVSH multiply defined (by mbed-os/targets/TARGET_STM/TARGET_STM32F0/device/stm32f0xx_hal_rcc_ex.o and mbed-os/targets/TARGET_STM/TARGET_STM32F0/TARGET_NUCLEO_F091RC/device/system_clock.o).
Finished: 0 information, 0 warning and 2 error messages.
make[1]: *** [mbed-os-example-blinky.elf] Error 1

[cmonr]

Alright, gonna see if this goes 2/2.
/morph export-build

[mbed-ci]

Exporter Build : SUCCESS

Build number : 1018
Build artifacts/logs : http://mbed-os.s3-website-eu-west-1.amazonaws.com/?prefix=builds/exporter/6274/