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.

Sign up for GitHub

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

Fixing doxygen warnings / errrors #146

Merged
merged 5 commits into from
Dec 20, 2024
Merged

Fixing doxygen warnings / errrors #146

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d3133f8
Update developer.yml
AlysonStahl-NOAA Dec 20, 2024
0f4e1b6
fix md file name
AlysonStahl-NOAA Dec 20, 2024
8ff2ead
debug
AlysonStahl-NOAA Dec 20, 2024
c8d7431
Update user_guide.md
AlysonStahl-NOAA Dec 20, 2024
8ce3c84
Update developer.yml
AlysonStahl-NOAA Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Doxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -976,7 +976,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.

USE_MDFILE_AS_MAINPAGE = @abs_top_srcdir@/docs/sp_user_guide.md
USE_MDFILE_AS_MAINPAGE = @abs_top_srcdir@/docs/user_guide.md

#---------------------------------------------------------------------------
# Configuration options related to source browsing
Expand Down
16 changes: 8 additions & 8 deletions docs/user_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
@mainpage

## Introduction
# Introduction

This document briefly describes the NCEPLIBS-g2tmpl library.

## GRIB2 Tables/Templates
# GRIB2 Tables/Templates

NCO Provides documentation on WMO GRIB2 at
https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/
Expand All @@ -15,9 +15,9 @@ descriptions of each template and code table information. This
document can be found at https://codes.wmo.int/grib2/_codeflag (PDF
and MSWord formats are available).

## Editing Parameters in the GRIB2 Tables
# Editing Parameters in the GRIB2 Tables

### GRIB2 - TABLE 4.2-0-0 PARAMETERS FOR DISCIPLINE 0 CATEGORY 0
## GRIB2 - TABLE 4.2-0-0 PARAMETERS FOR DISCIPLINE 0 CATEGORY 0

GRIB2 parameter table for all disciplines and categories and parameter. These fields are
in order as below:
Expand Down Expand Up @@ -74,7 +74,7 @@ The procedures are following:
</pre>
4. run the sort_params_grib2_tbl manually to write output file which it will be sorted.

## Adding New Generating Process ID or Model ID PDT in GRIB2 tables
# Adding New Generating Process ID or Model ID PDT in GRIB2 tables

The following variables are often requested by developers: parameters, model id or new
grid id to add to NCEPGRIB2 tables. Example:
Expand Down Expand Up @@ -159,7 +159,7 @@ Example:
==> The output file is: params_grib2_tbl_new file
5. We will give these two files: params_grib2_tbl_new.text and params_grib2_tbl_new to developer for testing and UPP (code manager is Wen).

### New Generating Process ID (see Code ON388 Table A) or Product Definition Template.
## New Generating Process ID (see Code ON388 Table A) or Product Definition Template.

(see PDT at https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/grib2_table4-0.shtml)
We need to modify the following files in g2tmpl library:
Expand All @@ -178,7 +178,7 @@ https://docs.google.com/document/d/1VK3j0K0CXRxaP7ZW-uJuyGKosVVAuIOkBBIafY2tzW0/
Wen Meng)
https://docs.google.com/document/d/1r2BQtAI33S_zCDh6Ko-aFW0kO79MYILspW31Bw4zE60/edit

### Maintaining NCEP WMO GRIB2 DOCUMENTATION and Update GRIB2 library
## Maintaining NCEP WMO GRIB2 DOCUMENTATION and Update GRIB2 library

The NCEP WMO grib2 document is on NCO RZDM web site:
https://www.nco.ncep.noaa.gov/pmb/docs/grib2/grib2_doc/ WMO updates
Expand Down Expand Up @@ -225,7 +225,7 @@ This file updates “Product Definition Templates” used in Section 4
This file updates the available parameters in GRIB2 tables.
* New file as needed (e.g., new compression, new feature, …)

### Documentation for Previous Versions of NCEPLIBS-g2tmpl
## Documentation for Previous Versions of NCEPLIBS-g2tmpl

* [NCEPLIBS-g2tmpl Version 1.11.0](ver-1.11.0/index.html)
* [NCEPLIBS-g2tmpl Version 1.10.0](ver-1.10.0/index.html)
Expand Down
Loading