[PR #551] [MERGED] [bugs,docs] Fixes to existing code for LGTM and documentation #974

Closed
opened 2026-01-29 15:16:33 +00:00 by claunia · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/TheAlgorithms/C/pull/551
Author: @kvedala
Created: 6/28/2020
Status: Merged
Merged: 6/28/2020
Merged by: @kvedala

Base: masterHead: docs/fix


📝 Commits (6)

  • 6470f03 fixed documentations
  • cf2a17e enable autobrief in documentation
  • 17c5523 fix lgtm error
  • 20bab2a fix lgtm error - lexicographic_permutations
  • 619620d fix LGTM error - c_atoi
  • 6710df7 fix LGTM - limit malloc range

📊 Changes

23 files changed (+106 additions, -98 deletions)

View changed files

📝 CMakeLists.txt (+1 -0)
📝 conversions/c_atoi_str_to_integer.c (+8 -4)
📝 data_structures/binary_trees/threaded_binary_trees.c (+2 -2)
📝 machine_learning/adaline_learning.c (+6 -5)
📝 machine_learning/kohonen_som_topology.c (+6 -9)
📝 machine_learning/kohonen_som_trace.c (+18 -18)
📝 misc/cartesian_to_polar.c (+1 -1)
📝 misc/factorial_large_number.c (+5 -5)
📝 misc/lexicographic_permutations.c (+5 -0)
📝 numerical_methods/durand_kerner_roots.c (+3 -3)
📝 numerical_methods/newton_raphson_root.c (+1 -1)
📝 numerical_methods/qr_eigen_values.c (+2 -1)
📝 project_euler/problem_13/sol1.c (+1 -1)
📝 project_euler/problem_14/sol1.c (+1 -1)
📝 project_euler/problem_15/sol1.c (+1 -1)
📝 project_euler/problem_19/sol1.c (+12 -11)
📝 project_euler/problem_20/sol1.c (+11 -11)
📝 project_euler/problem_21/sol1.c (+3 -3)
📝 project_euler/problem_22/sol1.c (+2 -2)
📝 project_euler/problem_23/sol1.c (+6 -6)

...and 3 more files

📄 Description

Description of Change

  • Doxygen doc syntaxes fixed
  • enabled doxygen autobrief to gernerate brief descriptions automatically when not explicitly provided.
  • Fixes for LGTM errors (#550)

Checklist

  • Added description of change
  • Added file name matches File name guidelines
  • Added tests and example, test must pass
  • Relevant documentation/comments is changed or added
  • PR title follows semantic commit guidelines
  • Search previous suggestions before making a new one, as yours may be a duplicate.
  • I acknowledge that all my contributions will be made under the project's license.

Notes:


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/TheAlgorithms/C/pull/551 **Author:** [@kvedala](https://github.com/kvedala) **Created:** 6/28/2020 **Status:** ✅ Merged **Merged:** 6/28/2020 **Merged by:** [@kvedala](https://github.com/kvedala) **Base:** `master` ← **Head:** `docs/fix` --- ### 📝 Commits (6) - [`6470f03`](https://github.com/TheAlgorithms/C/commit/6470f0318b1f741d53afb576f596df5fd617a9c2) fixed documentations - [`cf2a17e`](https://github.com/TheAlgorithms/C/commit/cf2a17e380e36d06b447e73dcccf0219ff676248) enable autobrief in documentation - [`17c5523`](https://github.com/TheAlgorithms/C/commit/17c55231290ae2ced896b5d00bb8543def0bc71d) fix lgtm error - [`20bab2a`](https://github.com/TheAlgorithms/C/commit/20bab2a5ae72bef9af768172c5d9300597462099) fix lgtm error - lexicographic_permutations - [`619620d`](https://github.com/TheAlgorithms/C/commit/619620d65d7bad40de208b963d155806798ba39f) fix LGTM error - c_atoi - [`6710df7`](https://github.com/TheAlgorithms/C/commit/6710df7ec38f1a05ab8a36cb0c1fb5a4fc11faeb) fix LGTM - limit malloc range ### 📊 Changes **23 files changed** (+106 additions, -98 deletions) <details> <summary>View changed files</summary> 📝 `CMakeLists.txt` (+1 -0) 📝 `conversions/c_atoi_str_to_integer.c` (+8 -4) 📝 `data_structures/binary_trees/threaded_binary_trees.c` (+2 -2) 📝 `machine_learning/adaline_learning.c` (+6 -5) 📝 `machine_learning/kohonen_som_topology.c` (+6 -9) 📝 `machine_learning/kohonen_som_trace.c` (+18 -18) 📝 `misc/cartesian_to_polar.c` (+1 -1) 📝 `misc/factorial_large_number.c` (+5 -5) 📝 `misc/lexicographic_permutations.c` (+5 -0) 📝 `numerical_methods/durand_kerner_roots.c` (+3 -3) 📝 `numerical_methods/newton_raphson_root.c` (+1 -1) 📝 `numerical_methods/qr_eigen_values.c` (+2 -1) 📝 `project_euler/problem_13/sol1.c` (+1 -1) 📝 `project_euler/problem_14/sol1.c` (+1 -1) 📝 `project_euler/problem_15/sol1.c` (+1 -1) 📝 `project_euler/problem_19/sol1.c` (+12 -11) 📝 `project_euler/problem_20/sol1.c` (+11 -11) 📝 `project_euler/problem_21/sol1.c` (+3 -3) 📝 `project_euler/problem_22/sol1.c` (+2 -2) 📝 `project_euler/problem_23/sol1.c` (+6 -6) _...and 3 more files_ </details> ### 📄 Description #### Description of Change <!-- Thank you for your Pull Request. Please provide a description above and review the requirements below. Contributors guide: https://github.com/TheAlgorithms/C-Plus-Plus/CONTRIBUTING.md --> * Doxygen doc syntaxes fixed * enabled doxygen autobrief to gernerate brief descriptions automatically when not explicitly provided. * Fixes for LGTM errors (#550) #### Checklist <!-- Remove items that do not apply. For completed items, change [ ] to [x]. --> - [x] Added description of change - [ ] Added file name matches [File name guidelines](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md#New-File-Name-guidelines) - [ ] Added tests and example, test must pass - [x] Relevant documentation/comments is changed or added - [x] PR title follows semantic [commit guidelines](https://github.com/TheAlgorithms/C-Plus-Plus/blob/master/CONTRIBUTING.md#Commit-Guidelines) - [x] Search previous suggestions before making a new one, as yours may be a duplicate. - [x] I acknowledge that all my contributions will be made under the project's license. Notes: <!-- Please add a one-line description for developers or pull request viewers --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
claunia added the pull-request label 2026-01-29 15:16:33 +00:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/C#974