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

KernelDoc: new parser #3619

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Conversation

masatake
Copy link
Member

@masatake masatake commented Jan 4, 2023

/** 
 * getData() - get data from containers 
 * 
 */
void * getData() {...

The first "getData" can be extracted as a tag with "documentation" role of "function" kind in C language or a tag with "function" kind of KenrelDoc language.

My choice in this pull request is the latter one.


TODO: revise Tmain/optscript-preludes-stack.d/stderr-expected.txt

@codecov
Copy link

codecov bot commented Jan 5, 2023

Codecov Report

Attention: 3 lines in your changes are missing coverage. Please review.

Comparison is base (6b06565) 82.99% compared to head (497985a) 82.94%.
Report is 421 commits behind head on master.

❗ Current head 497985a differs from pull request most recent head db68983. Consider uploading reports for the commit db68983 to get more accurate results

Files Patch % Lines
parsers/kerneldoc.c 97.61% 3 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #3619      +/-   ##
==========================================
- Coverage   82.99%   82.94%   -0.06%     
==========================================
  Files         226      225       -1     
  Lines       54972    54882      -90     
==========================================
- Hits        45626    45520     -106     
- Misses       9346     9362      +16     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Lang_kerneldoc = language;
}

static void inputStart (subparser *s)
Copy link
Member Author

Choose a reason for hiding this comment

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

Why is this line not covered?

@@ -0,0 +1,84 @@
/* Taken from linux/kernel/cpu.c */
Copy link
Member Author

Choose a reason for hiding this comment

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

enum and function() must be added to input-0.

…cts in C comments

TODO: revise Tmain/optscript-preludes-stack.d/stderr-expected.txt
This one is disabled by default.
Give --languages=+KernelDoc for enabling.

Signed-off-by: Masatake YAMATO <yamato@redhat.com>
@masatake masatake added this to the 6.2 milestone Dec 28, 2023
@masatake masatake modified the milestones: 6.2, 6.3 Dec 28, 2023
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.

1 participant