From b84d15e7f3b189a5a4f4ec2f616c3942f3fb7be9 Mon Sep 17 00:00:00 2001 From: giomba Date: Fri, 30 Sep 2022 08:14:45 +0200 Subject: [PATCH] Add documentation header to frame.cpp --- frame.cpp | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/frame.cpp b/frame.cpp index efdef40..f61a870 100644 --- a/frame.cpp +++ b/frame.cpp @@ -1,8 +1,16 @@ -/* frame.cpp - * Takes a black/white (1bpp) PNM ASCII-armored image as input, - * and produces the frame.S assembly code to draw it - * as an analog video signal for this project's kernel. - * */ +/** + * @file frame.cpp + * @author giomba@glgprograms.it + * @brief Transform a black and white PNM image into the assembly code for the video generator. + * + * Takes a black/white (1bpp) PNM ASCII-armored image as input, + * and produces the frame.S assembly code to draw it + * as an analog video signal for this project's kernel. + * + * @copyright Copyright retrofficina.glgprograms.it (c) 2021-2022 + * + */ + #include #include #include @@ -16,6 +24,7 @@ enum ExitStatus { int main(int argc, char** argv) { if (argc < 2) { + std::cerr << "Usage: " << argv[0] << " " << std::endl; return BAD_ARGUMENT; } const int images = argc - 1;