From 99397b49e86244f21e13b77abe48bfc4bfdd3f14 Mon Sep 17 00:00:00 2001 From: MooZ Date: Wed, 11 Oct 2023 21:05:13 +0200 Subject: [PATCH] Licence and comments gardening. --- cd.c | 49 +++++++++++----------------- cd.h | 32 +++++++++--------- comment.c | 32 +++++++++--------- comment.h | 32 +++++++++--------- config.h | 32 +++++++++--------- decode.c | 32 +++++++++--------- decode.h | 32 +++++++++--------- ipl.c | 48 +++++++++++---------------- ipl.h | 32 +++++++++--------- irq.c | 40 ++++++++++------------- irq.h | 32 +++++++++--------- jsonhelpers.c | 17 ++++++++++ jsonhelpers.h | 32 +++++++++--------- label.c | 82 +++++++++++++---------------------------------- label.h | 32 +++++++++--------- label/load.c | 32 +++++++++--------- label/save.c | 40 ++++++++++------------- memory.c | 50 +++++++++++------------------ memory.h | 32 +++++++++--------- memorymap.c | 63 ++++++++++++------------------------ memorymap.h | 32 +++++++++--------- message.c | 55 ++++++++++++------------------- message.h | 32 +++++++++--------- message/console.c | 38 ++++++++++------------ message/console.h | 32 +++++++++--------- message/file.c | 38 ++++++++++------------ message/file.h | 32 +++++++++--------- opcodes.c | 32 +++++++++--------- opcodes.h | 32 +++++++++--------- rom.c | 39 ++++++++++------------ rom.h | 32 +++++++++--------- section.c | 54 ++++++++++++------------------- section.h | 32 +++++++++--------- section/load.c | 41 ++++++++++-------------- section/load.h | 32 +++++++++--------- section/save.c | 41 ++++++++++-------------- section/save.h | 32 +++++++++--------- 37 files changed, 628 insertions(+), 771 deletions(-) diff --git a/cd.c b/cd.c index d9b8838..50ebcb1 100644 --- a/cd.c +++ b/cd.c @@ -1,28 +1,24 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include "cd.h" #include "message.h" -/** - * Adds CD RAM to memory map. - * \param map Memory map. - * \return 1 upon success, 0 if an error occured. - */ +/* Adds CD RAM to memory map. */ int cd_memmap(memmap_t *map) { int i, ret = 0; /* Allocate CD RAM */ @@ -48,16 +44,7 @@ int cd_memmap(memmap_t *map) { } return ret; } -/** - * Load CDROM data from file. - * \param [in] filename CDROM data filename. - * \param [in] start CDROM data offset. - * \param [in] len CDROM data length (in bytes). - * \param [in] page Memory page. - * \param [in] offset memory page offset. - * \param [out] memmap Memory map. - * \return 1 upon success, 0 if an error occured. - */ +/* Load CDROM data from file. */ int cd_load(const char* filename, size_t start, size_t len, uint8_t page, size_t offset, memmap_t* map) { int ret = 0; FILE *in = fopen(filename, "rb"); diff --git a/cd.h b/cd.h index adef135..dfe52d8 100644 --- a/cd.h +++ b/cd.h @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef ETRIPATOR_CD_H #define ETRIPATOR_CD_H diff --git a/comment.c b/comment.c index 44e8cc9..5fa7ac4 100644 --- a/comment.c +++ b/comment.c @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include "comment.h" #include "message.h" diff --git a/comment.h b/comment.h index 849ca5a..b3c3cab 100644 --- a/comment.h +++ b/comment.h @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef ETRIPATOR_COMMENT_H #define ETRIPATOR_COMMENT_H diff --git a/config.h b/config.h index 0c60b9f..4d1e3ad 100644 --- a/config.h +++ b/config.h @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef ETRIPATOR_CONFIG_H #define ETRIPATOR_CONFIG_H diff --git a/decode.c b/decode.c index e18da50..a5f0689 100644 --- a/decode.c +++ b/decode.c @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include "decode.h" #include "message.h" #include "opcodes.h" diff --git a/decode.h b/decode.h index f5e9e80..7122e91 100644 --- a/decode.h +++ b/decode.h @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef ETRIPATOR_DECODE_H #define ETRIPATOR_DECODE_H diff --git a/ipl.c b/ipl.c index a872c9b..a2c91ae 100644 --- a/ipl.c +++ b/ipl.c @@ -1,21 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ - + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include "ipl.h" #include "message.h" @@ -111,12 +110,7 @@ void ipl_print(ipl_t *in) { } } -/** - * Read IPL data from file. - * \param [out] out IPL infos. - * \param [in] filename Input filename. - * \return 0 on error, 1 otherwise. - */ +/* Read IPL data from file. */ int ipl_read(ipl_t *out, const char *filename) { FILE *in = fopen(filename, "rb"); int ret = 0; @@ -134,13 +128,7 @@ int ipl_read(ipl_t *out, const char *filename) { return ret; } -/** - * Get irq code offsets from IPL. - * \param [in] in IPL infos. - * \param [out] section Sections. - * \param [out] count Section count. - * \return 0 on error, 1 otherwise. - */ +/* Get irq code offsets from IPL. */ int ipl_sections(ipl_t *in, section_t **out, int *count) { int i, j, k, extra; section_t *section; diff --git a/ipl.h b/ipl.h index 49a144d..aff49e3 100644 --- a/ipl.h +++ b/ipl.h @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef IPL_H #define IPL_H diff --git a/irq.c b/irq.c index ace9c07..86817e4 100644 --- a/irq.c +++ b/irq.c @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include "irq.h" #include "message.h" @@ -29,13 +29,7 @@ static char* g_irq_names[PCE_IRQ_COUNT] = { "irq_reset" }; -/** - * Get irq code offsets from rom. - * \param [in] map Memory map. - * \param [out] section Sections. - * \param [out] count Section count; - * \return 0 on error, 1 otherwise. - */ +/* Get irq code offsets from rom. */ int irq_read(memmap_t* map, section_t **section, int *count) { int i; uint8_t addr[2]; diff --git a/irq.h b/irq.h index 25620da..72c7933 100644 --- a/irq.h +++ b/irq.h @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef ETRIPATOR_IRQ_H #define ETRIPATOR_IRQ_H diff --git a/jsonhelpers.c b/jsonhelpers.c index 707bb16..adc87e5 100644 --- a/jsonhelpers.c +++ b/jsonhelpers.c @@ -1,3 +1,20 @@ +/* + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include "jsonhelpers.h" #include diff --git a/jsonhelpers.h b/jsonhelpers.h index fd22e1c..117c480 100644 --- a/jsonhelpers.h +++ b/jsonhelpers.h @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef ETRIPATOR_JSON_HELPERS_H #define ETRIPATOR_JSON_HELPERS_H diff --git a/label.c b/label.c index dfc5f5f..a891d34 100644 --- a/label.c +++ b/label.c @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include "label.h" #include "message.h" @@ -47,10 +47,7 @@ static int label_repository_index(label_repository_t* repository, uint16_t logic return -1; } -/** - * Create label repository. - * \return A pointer to a label repository or NULL if an error occured. - */ +/* Create label repository. */ label_repository_t* label_repository_create() { label_repository_t *repository; repository = (label_repository_t*)malloc(sizeof(label_repository_t)); @@ -75,10 +72,7 @@ label_repository_t* label_repository_create() { return repository; } -/** - * Delete label repository. - * \param [in,out] repository Label repository. - */ +/* Delete label repository. */ void label_repository_destroy(label_repository_t* repository) { repository->size = 0; repository->last = 0; @@ -97,14 +91,7 @@ void label_repository_destroy(label_repository_t* repository) { } } -/** - * Add label to repository. - * \param [in,out] repository Label repository. - * \param [in] name Name. - * \param [in] logical Logical address. - * \param [in] page Memory page. - * \param [in] description Description (optional). - */ +/* Add label to repository. */ int label_repository_add(label_repository_t* repository, const char* name, uint16_t logical, uint8_t page, const char *description) { int ret = 1; int index = label_repository_index(repository, logical, page); @@ -145,14 +132,7 @@ int label_repository_add(label_repository_t* repository, const char* name, uint1 return ret; } -/** - * Find a label by its address. - * \param [in] repository Label repository. - * \param [in] logical Logical address. - * \param [in] page Memory page. - * \param [out] label Label (if found). - * \return 1 if a label was found, 0 otherwise. - */ +/* Find a label by its address. */ int label_repository_find(label_repository_t* repository, uint16_t logical, uint8_t page, label_t *out) { int index = label_repository_index(repository, logical, page); if(index < 0) { @@ -163,22 +143,12 @@ int label_repository_find(label_repository_t* repository, uint16_t logical, uint return 1; } -/** - * Get the number of labels stored in the repository. - * \param [in] repository Label repository. - * \return Label count. - */ +/* Get the number of labels stored in the repository. */ int label_repository_size(label_repository_t* repository) { return repository ? (int)repository->last : 0; } -/** - * Retrieve the label at the specified index. - * \param [in] repository Label repository. - * \param [in] index Label index. - * \param [out] out Label. - * \return 1 if a label exists for the specified index, 0 otherwise. - */ +/* Retrieve the label at the specified index. */ int label_repository_get(label_repository_t* repository, int index, label_t *out) { if((repository != NULL) && ((index >= 0) && (index < (int)repository->last))) { memcpy(out, &repository->labels[index], sizeof(label_t)); @@ -188,13 +158,7 @@ int label_repository_get(label_repository_t* repository, int index, label_t *out return 0; } } -/** - * Delete labels - * \param [in] repository Label repository. - * \param [in] first Start of the logical address range. - * \param [in] end End of the logical address range. - * \param [in] page Memory page. - */ +/* Delete labels */ int label_repository_delete(label_repository_t* repository, uint16_t first, uint16_t end, uint8_t page) { size_t i; for(i=0; ilast; i++) { diff --git a/label.h b/label.h index beba071..eadd6a6 100644 --- a/label.h +++ b/label.h @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef ETRIPATOR_LABEL_H #define ETRIPATOR_LABEL_H diff --git a/label/load.c b/label/load.c index 6c56626..4d6150b 100644 --- a/label/load.c +++ b/label/load.c @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009-2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include #include "../message.h" #include "../jsonhelpers.h" diff --git a/label/save.c b/label/save.c index e7ffc67..58b0c8f 100644 --- a/label/save.c +++ b/label/save.c @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include #include @@ -22,13 +22,7 @@ #include "../jsonhelpers.h" #include "../label.h" -/** - * Save labels to file. - * \param [in] filename Configuration file. - * \param [in] reposity Label repository. - * \return 1 if the labels in the repository were succesfully written to the file. - * 0 if an error occured. - */ +/* Save labels to file. */ int label_repository_save(const char* filename, label_repository_t* repository) { FILE *stream = fopen(filename, "wb"); int i, count = label_repository_size(repository); diff --git a/memory.c b/memory.c index 5873373..76fc1cf 100644 --- a/memory.c +++ b/memory.c @@ -1,28 +1,23 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include "memory.h" #include "message.h" -/** - * Create memory block. - * \param [out] mem Memory block. - * \param [in] len Memory block size (in bytes). - * \return 1 upon success, 0 if an error occured. - */ +/* Create memory block. */ int mem_create(mem_t *mem, size_t len) { mem->data = (uint8_t*)malloc(len); if(!mem->data) { @@ -33,10 +28,7 @@ int mem_create(mem_t *mem, size_t len) { mem->len = len; return 1; } -/** - * Destroy memory block. - * \param [in] mem Memory block. - */ +/* Destroy memory block. */ void mem_destroy(mem_t *mem) { if(mem) { mem->len = 0; @@ -46,11 +38,7 @@ void mem_destroy(mem_t *mem) { } } } -/** - * Fill memory block bytes with a given byte value. - * \param [in] mem Memory block. - * \param [in] c Byte value. - */ +/* Fill memory block bytes with a given byte value. */ void mem_fill(mem_t *mem, uint8_t c) { if(mem->data && mem->len) { memset(mem->data, (int)mem->len, c); diff --git a/memory.h b/memory.h index 5e5d513..1af0554 100644 --- a/memory.h +++ b/memory.h @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef ETRIPATOR_MEMORY_H #define ETRIPATOR_MEMORY_H diff --git a/memorymap.c b/memorymap.c index e36f071..6c59b62 100644 --- a/memorymap.c +++ b/memorymap.c @@ -1,27 +1,23 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include "memorymap.h" #include "message.h" -/** - * Initializes memory map. - * \param map Memory map. - * \return 1 upon success, 0 if an error occured. - */ +/* Initializes memory map. */ int memmap_init(memmap_t *map) { int i, ret = 0; memset(map, 0, sizeof(memmap_t)); @@ -46,10 +42,7 @@ int memmap_init(memmap_t *map) { } return ret; } -/** - * Releases resources used by the memory map. - * \param map Memory map. - */ +/* Releases resources used by the memory map. */ void memmap_destroy(memmap_t *map) { int i; for(i=0; i> 13) & 0x07; return map->mpr[id]; } -/** - * Reads a single byte from memory. - * \param [in] map Memory map. - * \param [in] logical Logical address. - * \return Byte read. - */ +/* Reads a single byte from memory. */ uint8_t memmap_read(memmap_t *map, size_t logical) { uint8_t i = memmap_page(map, (uint16_t)logical); return (map->page[i]) ? map->page[i][logical & 0x1fff] : 0xff; } -/** - * Update mprs. - * \param [in][out] map Memory map. - * \param [in] mpr Memory page registers. - */ +/* Update mprs. */ void memmap_mpr(memmap_t *map, const uint8_t *mpr) { memcpy(map->mpr, mpr, 8); } diff --git a/memorymap.h b/memorymap.h index e566ec9..80752e7 100644 --- a/memorymap.h +++ b/memorymap.h @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef ETRIPATOR_MEMORY_MAP_H #define ETRIPATOR_MEMORY_MAP_H diff --git a/message.c b/message.c index 78221d9..2201fee 100644 --- a/message.c +++ b/message.c @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include "config.h" #include "message.h" @@ -22,27 +22,19 @@ static msg_printer_t* g_msg_printer = NULL; -/** - * Setup global message printer list. - */ +/* Setup global message printer list. */ void msg_printer_init() { g_msg_printer = NULL; // nothing much atm... } -/** - * Releases the resources used by message printers. - */ +/* Releases the resources used by message printers. */ void msg_printer_destroy() { msg_printer_t* printer; for(printer=g_msg_printer; NULL != printer; printer=printer->next) { printer->close(printer); } } -/** - * Adds a new message printer to the global list. - * \param [in] printer Message printer to be added to the list. - * \return 0 upon success. - */ +/* Adds a new message printer to the global list. */ int msg_printer_add(msg_printer_t *printer) { if(printer->open(printer)) { return 1; @@ -51,14 +43,7 @@ int msg_printer_add(msg_printer_t *printer) { g_msg_printer = printer; return 0; } -/** - * Dispatch messages to printers. - * \param type Message type. - * \param file Name of the file where the print message command was issued. - * \param line Line number in the file where the print message command was issued. - * \param function Function where the print message command was issued. - * \param format Format string. - */ +/* Dispatch messages to printers. */ void print_msg(msg_type_t type, const char* file, size_t line, const char* function, const char* format, ...) { msg_printer_t* printer; const char* filename; diff --git a/message.h b/message.h index bc918aa..c6a19d9 100644 --- a/message.h +++ b/message.h @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef ETRIPATOR_MESSAGE_H #define ETRIPATOR_MESSAGE_H diff --git a/message/console.c b/message/console.c index 255200f..1f85bbc 100644 --- a/message/console.c +++ b/message/console.c @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include "../config.h" #include "console.h" @@ -101,11 +101,7 @@ static int console_msg_printer_output(void* impl, msg_type_t type, const char* f return ret; } -/** - * \brief Setups console message writer. - * \param [in] printer Console message printer. - * \return 0 upon success. - */ +/* Setups console message writer. */ int console_msg_printer_init(console_msg_printer_t *printer) { printer->super.open = console_msg_printer_open; printer->super.close = console_msg_printer_close; diff --git a/message/console.h b/message/console.h index 196f220..e6c2ecd 100644 --- a/message/console.h +++ b/message/console.h @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef ETRIPATOR_MESSAGE_CONSOLE_H #define ETRIPATOR_MESSAGE_CONSOLE_H diff --git a/message/file.c b/message/file.c index 6782ff7..c872cfa 100644 --- a/message/file.c +++ b/message/file.c @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include "../config.h" #include "file.h" @@ -96,11 +96,7 @@ static int file_msg_printer_output(void* impl, msg_type_t type, const char* file return ret; } -/** - * \brief Setups file message writer. - * \param [in] impl Msg printer implementation. - * \return 0 upon success. - */ +/* Setups file message writer. */ int file_msg_printer_init(file_msg_printer_t *printer) { printer->super.open = file_msg_printer_open; printer->super.close = file_msg_printer_close; diff --git a/message/file.h b/message/file.h index 95dd417..3639498 100644 --- a/message/file.h +++ b/message/file.h @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef ETRIPATOR_MESSAGE_FILE_H #define ETRIPATOR_MESSAGE_FILE_H diff --git a/opcodes.c b/opcodes.c index 130d5d7..71e934e 100644 --- a/opcodes.c +++ b/opcodes.c @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include "opcodes.h" #define PCE_TYPE_COUNT 23 diff --git a/opcodes.h b/opcodes.h index 5e2af81..bf51236 100644 --- a/opcodes.h +++ b/opcodes.h @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef ETRIPATOR_OPCODES_H #define ETRIPATOR_OPCODES_H diff --git a/rom.c b/rom.c index 686500b..69ba6e6 100644 --- a/rom.c +++ b/rom.c @@ -1,29 +1,24 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include "message.h" #include "rom.h" -/** - * Load ROM from file. - * \param [in] filename ROM filename. - * \param [out] memmap Memory map. - * \return 1 upon success, 0 if an error occured. - */ +/* Load ROM from file. */ int rom_load(const char* filename, memmap_t* map) { FILE *in; int i; diff --git a/rom.h b/rom.h index 285cc26..1164022 100644 --- a/rom.h +++ b/rom.h @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef ETRIPATOR_ROM_H #define ETRIPATOR_ROM_H diff --git a/section.c b/section.c index 30f8d81..245b706 100644 --- a/section.c +++ b/section.c @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include "section.h" #include "jsonhelpers.h" #include "message.h" @@ -36,9 +36,7 @@ static const char *g_supported_data_types[DataTypeCount] = { "string" }; -/** - * Retrieves section type name. - */ +/* Retrieves section type name. */ const char* section_type_name(section_type_t type) { if((type <= UnknownSectionType) || (type >= SectionTypeCount)) { return "unknown"; @@ -46,9 +44,7 @@ const char* section_type_name(section_type_t type) { return g_supported_section_types[type]; } -/** - * Retrieves data type name. - */ +/* Retrieves data type name. */ const char* data_type_name(data_type_t type) { if((type <= UnknownDataType) || (type >= DataTypeCount)) { return "unknown"; @@ -56,9 +52,7 @@ const char* data_type_name(data_type_t type) { return g_supported_data_types[type]; } -/** - * Reset a section to its default values. - **/ +/* Reset a section to its default values. */ void section_reset(section_t *s) { s->name = NULL; s->type = UnknownSectionType; @@ -83,18 +77,12 @@ static int section_compare(const void *a, const void *b) { return cmp; } -/** - * Group section per output filename and sort them in bank/org order. - * \param [in][out] sections Sections. - * \param [in] count Number of sections to sort. - */ +/* Group section per output filename and sort them in bank/org order. */ void section_sort(section_t *ptr, size_t n) { qsort(ptr, n, sizeof(section_t), §ion_compare); } -/** - * Delete sections. - */ +/* Delete sections. */ void section_delete(section_t *ptr, int n) { int i; for(i=0; i. -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef ETRIPATOR_SECTION_H #define ETRIPATOR_SECTION_H diff --git a/section/load.c b/section/load.c index 0877121..ae2e3a3 100644 --- a/section/load.c +++ b/section/load.c @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include "load.h" #include @@ -177,14 +177,7 @@ static int section_parse(const json_t *obj, section_t *out) { return 1; } -/** - * Load sections from a JSON file. - * \param [in] filename Input filename. - * \param [out] sections Loaded sections. - * \param [out] count Number of loaded sections. - * \return 1 if the sections contained in the file were succesfully loaded. - * 0 if an error occured. - */ +/* Load sections from a JSON file. */ int section_load(const char *filename, section_t **out, int *n) { json_t* root; json_t* obj; diff --git a/section/load.h b/section/load.h index 412c258..262db3e 100644 --- a/section/load.h +++ b/section/load.h @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef ETRIPATOR_SECTION_LOAD_H #define ETRIPATOR_SECTION_LOAD_H diff --git a/section/save.c b/section/save.c index 9f8d324..778ea73 100644 --- a/section/save.c +++ b/section/save.c @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #include "save.h" #include "../jsonhelpers.h" @@ -23,14 +23,7 @@ #include #include -/** - * Save sections to a JSON file. - * \param [in] filename Output filename. - * \param [in] sections Sections to be saved. - * \param [in] count Number of sections. - * \return 1 if the sections were succesfully saved. - * 0 if an error occured. - */ +/* Save sections to a JSON file. */ int section_save(const char *filename, section_t *ptr, int n) { int i; FILE *out = fopen(filename, "wb"); diff --git a/section/save.h b/section/save.h index 67caf5e..2d1625e 100644 --- a/section/save.h +++ b/section/save.h @@ -1,20 +1,20 @@ /* - This file is part of Etripator, - copyright (c) 2009--2023 Vincent Cruz. - - Etripator 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 3 of the License, or - (at your option) any later version. - - Etripator 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 Etripator. If not, see . -*/ + * This file is part of Etripator, + * copyright (c) 2009--2023 Vincent Cruz. + * + * Etripator 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 3 of the License, or + * (at your option) any later version. + * + * Etripator 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 Etripator. If not, see . + */ #ifndef ETRIPATOR_SECTION_SAVE_H #define ETRIPATOR_SECTION_SAVE_H