Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation comments #18

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

JerelJr
Copy link

@JerelJr JerelJr commented Oct 27, 2024

In reference to #3.

  • Moved function description comments to header files
  • Corrected tcp_network_manager description; return type is bool not void
  • Regenerated documentation

@VedantParanjape
Copy link
Owner

Hey Thanks for the PR. Can you remove the generated html files? I will handle that on end!

@JerelJr
Copy link
Author

JerelJr commented Oct 27, 2024

Can do!

@VedantParanjape
Copy link
Owner

Hey there are still changes in docs folder.

@JerelJr
Copy link
Author

JerelJr commented Nov 5, 2024

My mistake. I thought you only wanted the HTML files removed

@VedantParanjape
Copy link
Owner

Hey, I think you messed up the commit, you need to roll back the commit and then just add the header changes to the commit. Now it seems you deleted the complete doc folder in your repo.

@JerelJr
Copy link
Author

JerelJr commented Nov 9, 2024

Ah my mistake. Will fix.

- Moved function description comments to header files
- Corrected tcp_network_manager function description
char* generate_log_message_timestamp(uint log_level, uint32_t timestamp, char* log_message);

#ifdef __cplusplus
}
#endif

#endif
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you add back the new line?

bool is_connected(void* handle_t);

#ifdef __cplusplus
}
#endif

#endif

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this as well.

return c_log_string;
}
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this as well.

@JerelJr
Copy link
Author

JerelJr commented Nov 20, 2024

Just for clarity, you want me to add a new line to the end of each of those files, correct?

@VedantParanjape
Copy link
Owner

Just for clarity, you want me to add a new line to the end of each of those files, correct?

yeah, correct, undo the changes basically.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants