Skip to content

Commit

Permalink
chore(docs): close group definitions
Browse files Browse the repository at this point in the history
This would cause the structures' fields to appear as variable inside
Doxygen's result, and make it quite unreadable.
  • Loading branch information
d4ilyrun committed May 23, 2024
1 parent 040c11d commit 4e1c218
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 1 deletion.
2 changes: 2 additions & 0 deletions include/kernel/arch/i686/interrupts.h
Original file line number Diff line number Diff line change
Expand Up @@ -175,3 +175,5 @@ static ALWAYS_INLINE bool interrupts_test_and_disable(void)
}

#endif /* KERNEL_I686_INTERRUPTS_H */

/** @} */
2 changes: 2 additions & 0 deletions include/kernel/mmu.h
Original file line number Diff line number Diff line change
Expand Up @@ -108,3 +108,5 @@ void mmu_identity_map(paddr_t start, paddr_t end, int prot);
paddr_t mmu_find_physical(vaddr_t);

#endif /* KERNEL_MMU_H */

/** @} */
1 change: 1 addition & 0 deletions include/kernel/process.h
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ typedef struct process {
/** Information relative to the current state of the process */
union {

/** For running processes only */
struct {
/** End of the currently running process's timeslice */
timestamp_t preempt;
Expand Down
2 changes: 2 additions & 0 deletions include/kernel/spinlock.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,5 @@ static ALWAYS_INLINE void spinlock_release(spinlock_t *lock)
{
__atomic_clear(&lock->locked, __ATOMIC_RELEASE);
}

/** @} */
2 changes: 2 additions & 0 deletions include/kernel/symbols.h
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,5 @@ ALWAYS_INLINE const char *kernel_symbol_name(const kernel_symbol_t *sym)
const kernel_symbol_t *kernel_symbol_from_address(u32 address);

#endif /* KERNEL_SYMBOLS_H */

/** @} */
2 changes: 2 additions & 0 deletions kernel/memory/pmm.c
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,8 @@ static bool pmm_initialize_bitmap(struct multiboot_info *mbt)
return true;
}

/** @} */

bool pmm_init(struct multiboot_info *mbt)
{
log_info("PMM", "Initializing pageframe allocator");
Expand Down
3 changes: 2 additions & 1 deletion lib/libalgo/include/libalgo/libalgo.h
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
* Libalgo is my own implementation of different datastructures and algorithms
* used by the kernel.
*
* They are not necessarily optimized, nor well design, but at least they exist.
* They are not necessarily optimized, nor well design, but they have the merit
* to they exist.
*
*/

Expand Down
2 changes: 2 additions & 0 deletions lib/libalgo/include/libalgo/linked_list.h
Original file line number Diff line number Diff line change
Expand Up @@ -152,3 +152,5 @@ static inline void llist_insert_sorted(llist_t *head, node_t *new,

__llist_add(head, prev, new);
}

/** @} */
2 changes: 2 additions & 0 deletions lib/libalgo/include/libalgo/queue.h
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,5 @@ static ALWAYS_INLINE const node_t *queue_peek(const queue_t *queue)
{
return queue->head;
}

/** @} */

0 comments on commit 4e1c218

Please sign in to comment.