Self Documenting Code Post: 302770205

6 More Discussions You Might Find Interesting

1. UNIX for Dummies Questions & Answers

Documenting a Shell Script

I've been working on a very long shell script that's becoming a mini-application. It is my first script, and continues to grow each week, becoming more and more complex. I've been asked to document my script, beginning with basic information and then detailing any information about its...

2. UNIX for Dummies Questions & Answers

Any easy way of documenting cron entries?

I've been asked to do a high level summary of the cron jobs which run against a number of systems (to understand the potential scope for rewriting some of our core systems)...and was wondering how people have done this in the past. I've got approx 400 cron entries to go through. I will have...

3. Programming

Documenting code

I am programming using C++ and am wondering how to comment my project. For example, when I declare a class I created a header with some description, then have the declaration stage, which I don't comment. Then when I define the actual functions I will put details about it, what it does,...

4. Shell Programming and Scripting

Script Help -- documenting specific users that log into server

Hello All, I am trying trying to write a shell script that will do a couple things: 1.) Identify any username that logs into the server. 2.) When the user logs out, send them an email detailing their log in/out times, duration logged in, and what processes they ran. Basically,...

5. Shell Programming and Scripting

Documenting files with sed

All, I am looking for a way to improve this small one liner. one of the files has this kind of format public func <<<T>(array: , offset: Int) -> { return array.shiftedLeft(by: offset) } gsed -i '/public func/i /\/\/\public func \n/\/\==mark==public func' tresults in ///public func ...

6. Web Development

Documenting Installation Problem with vue-beautiful-chat

REF: https://github.com/mattmezza/vue-beautiful-chat $ git clone https://github.com/mattmezza/vue-beautiful-chat.git Cloning into 'vue-beautiful-chat'... remote: Enumerating objects: 534, done. remote: Total 534 (delta 0), reused 0 (delta 0), pack-reused 534 Receiving objects: 100%...

LEARN ABOUT SUNOS

wsprintf

wsprintf(3C)						   Standard C Library Functions 					      wsprintf(3C)

NAME

       wsprintf - formatted output conversion

SYNOPSIS

       #include <stdio.h>
       #include <widec.h>

       int wsprintf(wchar_t *s, const char *format, /* arg */ ... ););

DESCRIPTION

       The wsprintf() function outputs a Process Code string ending with a Process Code (wchar_t) null character.  It is the user's responsibility
       to allocate enough space for this wchar_t string.

       This returns the number of Process Code characters (excluding the null terminator) that have been written.  The	conversion  specifications
       and behavior of wsprintf() are the same as the regular sprintf(3C) function except that the result is a Process Code string for wsprintf(),
       and on Extended Unix Code (EUC) character string for sprintf().

RETURN VALUES

       Upon successful completion, wsprintf() returns the number of characters printed. Otherwise, a negative value is returned.

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       |MT-Level		     |MT-Safe			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       wsscanf(3C), printf(3C), scanf(3C), sprintf(3C), attributes(5)

SunOS 5.10							    29 Dec 1996 						      wsprintf(3C)