Sponsored Content
Full Discussion: Self Documenting Code
The Lounge What is on Your Mind? Cartoons for Geeks Self Documenting Code Post 302770205 by Linux Bot on Thursday 14th of February 2013 05:15:02 PM
Old 02-14-2013
Self Documenting Code

2013-02-14T23:10:20+01:00
Image


Tweet
Image Image Image Image
Image

Source...
 

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... (1 Reply)
Discussion started by: yongho
1 Replies

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... (2 Replies)
Discussion started by: GavP
2 Replies

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,... (2 Replies)
Discussion started by: kristinu
2 Replies

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,... (3 Replies)
Discussion started by: SecureScript
3 Replies

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 ... (5 Replies)
Discussion started by: f77hack
5 Replies

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%... (2 Replies)
Discussion started by: Neo
2 Replies
pubsub(1)						    BSD General Commands Manual 						 pubsub(1)

NAME
pubsub -- Utility for managing RSS/Atom subscriptions via the PubSub framework SYNOPSIS
pubsub [--client bundleID] subcommand [parameters] OPTIONS
The available options are as follows: --client Force tool to act as one specific client ENVIRONMENT
The pubsub tool is a command-line utility for interacting with the PubSub framework. It is intended for troubleshooting, as a simple way to see at a glance all the feed subscriptions that the agent will be periodically fetching, and to delete any left-over subscriptions (for exam- ple, of an application that's been deleted.) If the --client flag is given, the tool will act only on the PubSub client with the given bundle ID. For example, pubsub list will list only the feeds that client is subscribed to. Some subcommands, such as subscribe, require a client to be specified. The following subcommands are supported. Note that some have multi-word names. If no subcommand is given, a short listing of their names will be output. list Lists all feeds (of all clients, or of the specific client if the -client flag is given.) The title, URL and refresh interval of each feed are shown. Note that a feed subscribed by multiple clients will be listed once per client, and that each client may specify a different refresh interval. However, the PubSub agent will only fetch one copy of the feed, at the minimum interval. The interval is listed in parentheses if it is inherited from the client's default refresh interval. The interval is followed by a " * " if the feed will be refreshed even when the client application is not currently running. The interval is followed by a " * " if file enclosures will automatically be downloaded. list clients Lists all registered clients by bundle ID, along with their number of subscriptions. list client bundleID Lists only the feeds subscribed to by the given client. unsubscribe URL Unsubscribes from the feed with the given URL. subscribe URL Subscribes the client (which must be specified using --client ) to the given feed. list URL Lists all entries currently stored for the given feed. dump URL Prints the raw XML of the feed, as it was last fetched from the network. list entry identifier Lists the attributes of an individual entry, given its identifier (a 40-char hex string). dump entry identifier Prints the XML of an entry, given its identifier (a 40-char hex string). refresh URL Fetches the feed from the network immediately, and updates the database if it has changed. listen [timestamp] Installs a PSClient delegate and listens for changes to subscribed feeds and entries, printing messages when they occur. If a time- stamp is given, all changes that have occurred since that time will first be printed. The timestamp is given as a number of seconds since the system "reference date", i.e. the same as the result of -[NSDate timeIntervalSinceReferenceDate]. list downloads Lists all enclosures currently being downloaded. list enclosures Lists all enclosures, and their current download status. FILES
~/Library/PubSub/ Per-user PubSub configuration/data directory EXAMPLES
pubsub list pubsub --client com.example.SurfNews subscribe http://example.com/UninterestingFeed.xml pubsub unsubscribe http://example.com/UninterestingFeed.xml Mac OS X 10.5 February 1, 2007 Mac OS X 10.5
All times are GMT -4. The time now is 08:23 AM.
Unix & Linux Forums Content Copyright 1993-2022. All Rights Reserved.
Privacy Policy