Merged
Conversation
Updates the Doxygen style guide to enforce stricter documentation rules, including mandatory public API documentation, specific tag order, and file headers. Introduces guidelines for templates, concepts, and internal code. Enhances clarity with allowed module groups and formatting rules. Establishes a comprehensive pre-merge checklist to ensure compliance.
Removes commented-out code for cleanup.
Corrects typos and formatting inconsistencies in Doxyfile, including input encoding and inline member settings. Updates path patterns for exclusions and shortens displayed paths in HTML output. Adds a warning log file and adjusts markdown and style options for improved documentation clarity. Updates `.gitignore` to exclude generated Doxygen HTML files.
Refine getPort() comment, and add comment for getDefaultServerName().
Improves Doxygen settings by adjusting options for inline members, documentation visibility, and sorting behavior. Introduces a custom layout file for better navigation in generated documentation. Refactors server-related files for clarity and modularity: renames files for consistency, updates include guards, and enhances documentation grouping. Aligns namespace and grouping annotations with updated Doxygen structure. Fixes minor issues in the build configuration and adds a warnings log to track Doxygen output. Adjusts function signatures and comments to improve readability and maintainability.
Enhances documentation across various modules with detailed groupings, descriptions, and usage notes for utility functions. Adds missing file-level summaries and clarifies behavior, error handling, and intended usage for key methods. Fixes minor inconsistencies in formatting and eliminates redundant or outdated comments across utility implementations.
…gen groupings, and refine method descriptions
…tion Adds comprehensive docstrings and inline comments across configuration-related components, improving readability and maintainability.
…guration parsing details The outdated CONTRIBUTING.md file has been removed, as its content is no longer relevant or applicable. Key sections were either redundant or replaced by newer practices. README.md has been updated to include detailed documentation on the configuration parsing flow, covering tokenization, parsing, normalization, validation, and error handling. These additions provide a comprehensive overview of the configuration pipeline and its rules. This update improves clarity for contributors by consolidating essential information into the README and reducing redundancy across the repository.
Cleans up Doxygen configuration by removing unused directories, files, and outdated documentation references. Updates settings to limit graph node count, reduce threads, and disable multi-targets for consistency. Enhances documentation generation workflow by clearing previous output and adjusts input sources for accuracy. Deletes redundant comments and unused helper functions for streamlined codebase.
…tation Enhances build process and documentation triggers Adds a manual trigger for the documentation workflow and optimizes compiler flags for improved performance. Updates Python virtual environment setup for test dependencies and standardizes `#include` directives for consistency. Corrects minor configuration and formatting issues across multiple files. Merges changes from `dev` branch into the feature branch to align with recent updates.
Reorganizes and updates the Makefile setup, including a new dedicated Makefile for to0nsa. Adds `.pytest_cache/` to `.gitignore` and includes a categorized help section for Makefile targets in the README. Removes redundant test and script files, consolidating functionality into the primary Makefile. Improves clarity, efficiency, and maintainability of the build and test workflows.
Refines project directory structure for clarity by renaming the unit test folder, updating documentation descriptions, and adding a Python test entry point.
Adds a detailed overview of the core components and program entrypoint of Webserv, including responsibilities of `Server`, `Location`, and `runWebserv`.
Documents SocketManager's core functionality, including connection management, timeout handling, CGI integration, and response processing.
Corrects a typo in the Doxygen group name from "socker_mananager" to "socket_manager" across multiple files for consistency and clarity. Enhances code readability and maintainability by organizing methods into named Doxygen groups with appropriate tags. Removes unused internal documentation and adjusts formatting in several method definitions for improved alignment.
Introduces a detailed explanation of the SocketManager, including its role in managing I/O through a `poll()` loop, handling connections, enforcing timeouts, and error recovery. Adds a high-level flow diagram using Mermaid to visualize the networking process, enhancing clarity.
Improves maintainability by adding detailed Doxygen comments to HTTP-related classes, methods, and utilities for better clarity and adherence to HTTP/1.1 standards. Includes updates to `HttpRequest`, `HttpResponse`, `HttpRequestParser`, and response builders. Clarifies logic for error pages, redirects, and file-backed responses while ensuring compliance with HTTP protocol semantics.
Adds comprehensive inline documentation to clarify the HTTP request routing process, including step-by-step workflows, helper function roles, and error handling. Improves maintainability and developer understanding of routing logic, covering key operations like directory slash redirects, location resolution, method validation, and handler dispatch.
Introduces detailed comments and documentation for HTTP GET, POST, and DELETE handlers, improving clarity and maintainability. Includes comprehensive inline documentation to aid future development and troubleshooting.
Enhances the README with comprehensive project details, including the HTTP server's features, request processing flow, and CGI handling. Updates the doxygen.warnings file, fixing line references and removing outdated error messages. Adjusts a Doxygen group annotation in handleCgi.cpp for consistency. These changes improve clarity for developers and address unresolved documentation references, ensuring better maintainability and usability.
Full project documentation creation and review
…ild configuration
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.