Skip to content

Commit

Permalink
changed doxygen comment style
Browse files Browse the repository at this point in the history
Hopefully this will work the github workflow to properly generate function documentation
  • Loading branch information
warrengalyen committed Feb 4, 2024
1 parent b493cbd commit a41e761
Show file tree
Hide file tree
Showing 3 changed files with 443 additions and 386 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<br />
<p style="text-align: center;">
<h1 style="text-align: center;">Ocular</h1>
<p align="center">
<h1 align="center">Ocular</h1>

<p style="text-align: center;">
<p align="center">
An image processing library implemented in pure-C
</p>
</p>
Expand All @@ -17,7 +17,7 @@ algorithms, without the use of any external dependencies. Suggestions for new fe
## Documentation

The documentation of the exported functions can be found
in [`ocular.h`](https://github.com/warrengalyen/improcc/blob/main/lib/ocular.h) and in
in [`ocular.h`](https://github.com/warrengalyen/ocular/blob/main/lib/ocular.h) and in
the [wiki](https://github.com/warrengalyen/ocular/wiki/Documentation).

## Features
Expand Down
5 changes: 4 additions & 1 deletion lib/ocular.c
Original file line number Diff line number Diff line change
Expand Up @@ -2960,6 +2960,9 @@ extern "C" {

bool ocularGetImageSize(const char* file_path, int* width, int* height, int* file_size) {

// Based on work by Paulo Scardine
// https://github.com/scardine/image_size

bool has_image_size = false;
*height = -1;
*width = -1;
Expand Down Expand Up @@ -3064,7 +3067,7 @@ extern "C" {
unsigned short num = 0;
fread(&num, 2, 1, fp);
if (num > 1) {
printf("this is a muti-ico file.");
printf("this is a multi-ico file.");
} else {
char w = 0, h = 0;
fread(&w, 1, 1, fp);
Expand Down
Loading

0 comments on commit a41e761

Please sign in to comment.