libc: Document functions in headers #11

apio · 2022-10-12T09:05:05Z

apio commented

2022-10-12 09:05:05 +00:00

Right now, header functions are of the sort:
int foo(int, const char*);

These prototypes are not very descriptive.

This pull request starts changing the headers to add parameter names to functions and a short description, to be more helpful and expressive.

Now foo would be:

// Does the foo operation bar times to the string baz.
int foo(int bar, const char* baz);

Which is a lot more readable.

Right now, header functions are of the sort: int foo(int, const char*); These prototypes are not very descriptive. This pull request starts changing the headers to add parameter names to functions and a short description, to be more helpful and expressive. Now foo would be: // Does the foo operation bar times to the string baz. int foo(int bar, const char* baz); Which is a lot more readable.

apio added 1 commit 2022-10-12 09:05:05 +00:00

libc: Document the functions in unistd.h 38e87d8f8f

apio added 1 commit 2022-10-12 09:19:21 +00:00

libc: Document the functions in string.h 19ee20b6f5

apio added 1 commit 2022-10-12 09:20:54 +00:00

Add a FIXME to string.cpp c8c4d31cca

apio added 1 commit 2022-10-12 09:30:28 +00:00

libc: Document functions in stdlib.h ffc223c2cf

Also, add prototypes for calloc() and realloc(), which were already implemented but not in the header.

apio added 1 commit 2022-10-12 09:51:40 +00:00

libc: Document the functions in stdio.h 6aabe19fb4

apio added 1 commit 2022-10-12 09:54:36 +00:00

libc: Document the functions in luna.h f44411aa46

apio added 2 commits 2022-10-12 09:58:14 +00:00

libc: Document the function in fcntl.h 9f5b3b76d2

Correct description for fopen() b42c866db8

apio added 2 commits 2022-10-12 10:01:24 +00:00

libc: Document errno.h 0d3e7d4463

libc: Update strerror() a3362429d3

apio added 1 commit 2022-10-12 10:06:53 +00:00

libc: Document functions in sys/mman.h 1e16a78106

apio added 1 commit 2022-10-12 10:07:48 +00:00

libc: Document sys/types.h d89685bb36

apio changed title from ~~WIP: libc: Document functions in headers~~ to libc: Document functions in headers

2022-10-12 10:11:23 +00:00

apio merged commit a8eb7a6b66 into main

2022-10-12 10:11:45 +00:00

apio deleted branch descriptive_headers

2022-10-12 10:11:45 +00:00

apio referenced this issue from a commit

2022-10-12 10:11:45 +00:00

Merge branch descriptive_headers into main

apio added the

enhancement

label 2022-10-12 10:12:05 +00:00

Sign in to join this conversation.

No reviewers

No Label

No Milestone

No project

No Assignees

1 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: apio/Luna#11