mirror/btstack
1
0
Fork 0
mirror of https://github.com/bluekitchen/btstack.git synced 2025-02-11 00:40:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

manual: more then one brief tag pro section supported

Browse Source
This commit is contained in:
Milanka Ringwald 2015-04-17 11:30:17 +02:00
parent 73e9dae855
commit e4255423da
2 changed files with 52 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
docs/manual/update_listings.py
View File

@ -48,8 +48,7 @@ listing_start = """
\\begin{lstlisting}[float, caption= LISTING_CAPTION., label=LISTING_LABLE]
"""
listing_ending = """
\end{lstlisting}
listing_ending = """\end{lstlisting}
"""
msp_folder = "../../platforms/msp-exp430f5438-cc2564b/example/"
@ -78,25 +77,35 @@ def replacePlaceholder(template, title, lable):
def writeListings(fout, infile_name):
lst_lable = ""
lst_caption = ""
listing = ""
state = State.SearchExampleStart
with open(infile_name, 'rb') as fin:
for line in fin:
section_parts = re.match('.*(@section)\s*(.*)(\s*\*/)\n',line)
section_parts = re.match('.*(@section)\s*(.*)\s*(\*?/?)\n',line)
if section_parts:
aout.write(example_subsection.replace("LISTING_CAPTION", section_parts.group(2)))
aout.write("\n" + example_subsection.replace("LISTING_CAPTION", section_parts.group(2)))
continue
brief_parts = re.match('.*(@brief)\s*(.*)\n',line)
subsection_parts = re.match('.*(@subsection)\s*(.*)\s*(\*?/?)\n',line)
if section_parts:
subsubsection = example_subsection.replace("LISTING_CAPTION", section_parts.group(2)).replace('section', 'subsection')
aout.write("\n" + subsubsection)
continue
brief_parts = re.match('.*(@brief)\s*(.*)',line)
if not brief_parts:
brief_parts = re.match('(\s\*\s)(.*)(\*/)?.*',line)
if brief_parts:
brief = " " + brief_parts.group(2)
else:
brief = brief_parts.group(2)
if brief_parts:
brief = brief_parts.group(2)+"\n"
if lst_lable:
brief = brief.replace(lst_lable, "\\ref{"+lst_lable+"}")
lst_lable = ""
# replace refs
refs = re.match('.*(Listing\s*)(\w*).*',brief)
if refs:
brief = brief.replace(refs.group(2), "\\ref{"+refs.group(2)+"}")
aout.write(brief)
if listing:
aout.write(listing)
listing = ""
continue
if state == State.SearchExampleStart:
@ -107,16 +116,19 @@ def writeListings(fout, infile_name):
desc = parts.group(3).replace("_","\_")
aout.write(example_section.replace("EXAMPLE_TITLE", title).replace("EXAMPLE_DESC", desc).replace("EXAMPLE_LABLE", lable))
state = State.SearchSnippetStart
continue
continue
if state == State.SearchSnippetStart:
parts = re.match('.*(SNIPPET_START)\((.*)\):\s*(.*)(\*/)?\n',line)
parts = re.match('.*(SNIPPET_START)\((.*)\):\s*(.*\s*)(\*/).*',line)
if parts:
lst_lable = parts.group(2)
lst_caption = parts.group(3).replace("_","\_")
listing = listing_start.replace("LISTING_CAPTION", lst_caption).replace("LISTING_LABLE", lst_lable)
if listing:
aout.write("\n" + listing)
state = State.SearchSnippetEnd
continue
continue
if state == State.SearchSnippetEnd:
parts_end = re.match('.*(SNIPPET_END).*',line)
@ -138,7 +150,7 @@ def writeListings(fout, infile_name):
parts = re.match('.*(SNIPPET_RESUME).*',line)
if parts:
state = State.SearchSnippetEnd
continue
continue
parts = re.match('.*(EXAMPLE_END).*',line)
if parts:

31
platforms/msp-exp430f5438-cc2564b/example/led_counter.c
View File

@ -29,11 +29,15 @@ static void run_loop_register_timer(timer_source_t *timer, uint16_t period){
run_loop_add_timer(timer);
}
/* @section Periodic Timer Setup */
/* SNIPPET_START(LEDToggler): Periodic counter
* @brief As timers in BTstack are single shot, the periodic counter is implemented by re-registering the timer source in the heartbeat handler callback function. Listing LEDToggler shows heartbeat handler adapted to periodically toggle an LED and print number of toggles.
*/
static void heartbeat_handler(timer_source_t *ts){
/* @section Periodic Timer Setup
* @brief As timers in BTstack are single shot,
* the periodic counter is implemented by re-registering the timer source in the
* heartbeat handler callback function. Listing LEDToggler shows heartbeat handler
* adapted to periodically toggle an LED and print number of toggles.
*/
/* SNIPPET_START(LEDToggler): Periodic counter */
static void heartbeat_handler(timer_source_t *ts){
// increment counter
char lineBuffer[30];
sprintf(lineBuffer, "BTstack counter %04u\n\r", ++counter);
@ -47,16 +51,27 @@ static void run_loop_register_timer(timer_source_t *timer, uint16_t period){
}
/* SNIPPET_END */
/* @section Turn On and Go */
/* SNIPPET_START(RunLoopExecution): Run loop execution
* @brief Listing RunLoopExecution shows how to setup and start the run loop. For hardware and BTstack setup, please check the source code in \path{../src/main.c}.
/* @section Turn On and Go
* @brief Listing RunLoopExecution shows how to setup and start the run loop.
* For hardware and BTstack setup, please check the source code in
* \path{../src/main.c}.
*/
/* SNIPPET_START(RunLoopExecution): Run loop execution */
static void timer_setup(){
// set one-shot timer
heartbeat.process = &heartbeat_handler;
run_loop_register_timer(&heartbeat, HEARTBEAT_PERIOD_MS);
}
/* SNIPPET_END */
/* @brief Listing MainConfiguration shows main application code. It is
* called after hardware and BTstack configuration (memory, run loop and
* transport layer) by the platform main in
* \path{platforms/PLATFORM_NAME/src/main.c}.
*/
/* SNIPPET_START(MainConfiguration): Hardware and BTstack configuration */
int btstack_main(int argc, const char * argv[]);
int btstack_main(int argc, const char * argv[]){
timer_setup();